gh-cli
A tool for easily installing front end language lint and formatting standards to projects.
Commands
Command | Description |
---|---|
standards [keywords...] |
Add standards for given standard keywords |
Standards
Standard | Keyword | Standard | Lint Tool | Formatting Tool |
---|---|---|---|---|
JavaScript | js |
@geekhive/eslint-config-standard | ESlint | Prettier |
TypeScript | ts |
@geekhive/tslint-config-standard | TSLint | Prettier |
SCSS | scss |
@geekhive/stylelint-config-standard | stylelint | Prettier |
Usage
Run with npx
:
# Run the CLI tool, installing JavaScript, TypeScript, and SCSS standards
npx @geekhive/gh-cli standards js ts scss
Install the CLI tool globally and use:
# Install globally with npm
npm install -g @geekhive/gh-cli
# Install globally with yarn
yarn add -g @geekhive/gh-cli
# Run the CLI tool, installing JavaScript, TypeScript, and SCSS standards
gh standards js ts scss
Development
Make sure to commit the build files as this allows running npx directly against a branch.
Run the watch task:
yarn run dev
Run a build:
yarn run build
Execute the CLI tool:
node dist/gh.js standards js ts scss
Debug the CLI tool:
node --inspect-brk dist/gh.js standards js ts scss