extension-cli/config/readme.md

CLI tool for building browser extensions

# CLI configuration files

This directory contains various files that are used by the available CLI commands. Below is a short summary of each to explain their purpose.

Path | Description
:--- | :---
**actions.yml** | Github actions starter configuration
**build.json** |  default file paths used by the build script
**docs.json** | JSDoc documentation template
**eslint.json** | default eslint configuration
**gitlab.yml** | Gitlab CI starter configuration
**ignore** | gitignore starter
**travis.yml** | Travis CI starter configuration
**init/** | Files for bootstrapping a new extension project 
   **└── NNxNN.png** | extension icons
   **└── background.js** | background script starter
   **└── icon.svg** | vector icon
   **└── intro.md** | new extension readme
   **└── manifest.json** | manifest template
   **└── messages.json** | message dictionary template
   **└── package.json** | package.json template
   **└── test.js** | unit test starter

**Notes**

- eslint, CI configuration files, (git)ignore can be pulled into a project through `xt-sync` command,
  or a project can specify these files independently.
  The idea is not having to start from scratch at project level unless it is by choice. 
- All files in `init` directory are included in a new extension project
  - files that should not be included in a newly generated project go in `/config` directory
- keep `init` directory flat on purpose to keep things simple — create command will generate
  the necessary structure