- Notifications
You must be signed in to change notification settings - Fork0
redding/l.rb
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A lint runner. Run locally configured lint commands via a generic CLI with standard options/features.
Open a terminal and run this command (view source):
(change PREFIX as needed; it defaults to/usr/local)
$ curl -L https://git.io/l.rb--install | PREFIX=/usr/local shGiven a./.l.yml in your project's root, e.g.:
source_file_paths: -app -config -db -lib -script -testignored_file_paths: -test/fixtureslinters: -name:"Rubocop"cmd:"rubocop"autocorrect_cmd:"rubocop -a"extensions: -".rb"cli_abbrev:"u" -name:"ES Lint"cmd:"./node_modules/.bin/eslint"extensions: -".js" -name:"SCSS Lint"cmd:"scss-lint"extensions: -".scss"
Then:
$ cd my/project$ l -hUsage: l [options] [FILES]Options: -u, --[no-]rubocop specifically run or don't run Rubocop -e, --[no-]es-lint specifically run or don't run ES Lint -s, --[no-]scss-lint specifically run or don't run SCSS Lint -c, --[no-]changed-only only run source files with changes -r, --changed-ref VALUE reference for changes, use with `-c` opt -a, --[no-]autocorrect autocorrect any correctable violations --[no-]dry-run output each linter command to $stdout without executing -l, --[no-]list list source files on $stdout -d, --[no-]debug run in debug mode --version --help$ l$ l -d[DEBUG] CLI init and parse... (6.686 ms)[DEBUG] 0 specified source files:Running Rubocop[DEBUG] rubocop .Running ES Lint[DEBUG] ./node_modules/.bin/eslint .Running SCSS Lint[DEBUG] scss-lint .This option, in addition to executing the linter command, outputs a bunch of detailed debug information.
$ l -d -c[DEBUG] CLI init and parse... (7.138 ms)[DEBUG] Lookup changed source files... (24.889 ms)[DEBUG] `git diff --no-ext-diff --name-only -- . && git ls-files --others --exclude-standard -- .`[DEBUG] 1 specified source files:[DEBUG] app/file1.rbRunning Rubocop[DEBUG] rubocop app/file1.rbRunning ES LintRunning SCSS LintThis runs a git command to determine which files have been updated (relative toHEAD by default) and only run the linters on those files.
You can specify a custom git ref to use instead:
$ l -d -c -r master[DEBUG] CLI init and parse... (6.933 ms)[DEBUG] Lookup changed source files... (162.297 ms)[DEBUG] `git diff --no-ext-diff --name-only master -- . && git ls-files --others --exclude-standard -- .`[DEBUG] 2 specified source files:[DEBUG] app/file2.js[DEBUG] app/file3.scssRunning ES Lint[DEBUG] ./node_modules/.bin/eslint app/file2.jsRunning SCSS Lint[DEBUG] scss-lint app/file3.scss$ l --dry-runRunning Rubocoprubocop .Running ES Lint./node_modules/.bin/eslint .Running SCSS Lintscss-lint .This option only outputs the linter command it would have run. It does not execute the linter command.
$ l --dry-run -aRunning Rubocoprubocop -a .This option runs the optionalautocorrect_cmd configured on the linters. If linters do not define an autocorrect cmd, they will not be run.
$ l --rubocopRunning Rubocoprubocop .$ l --no-es-lintRunning Rubocoprubocop .Running SCSS Lintscss-lint .Each linter gets a CLI option that allows you to toggle it on/off. If no options are given, all linters are run.
$ l -lapp/file1.rbapp/file2.jsapp/file3.scssThis option, similar to--dry-run, does not execute any linter command. It lists out each source file it would execute to$stdout.
Optional. A list of paths to look for source files. Defaults to["./"].
Optional. A list of source file paths to ignore. Defaults to[].
Required. A list of linter configurations to run. Each linter will be run in the order it is listed.
Required. A String name used to identify the linter.
Required. The system command to use.
Required. A list of file extensions to identify the files that should be linted.
Optional. An String letter used as the abbreviated CLI flag for the linter. Defaults to the first letter of the lintersname:. Cannot be"c","r","l", or"d" as these conflict with other CLI options.
Ruby~> 2.5.
Git.
Open a terminal and run this command (view source):
$ curl -L http://git.io/l.rb---uninstall | sh- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request