feat: Add debug logs #344

sudo-suhas · 2017-11-26T07:42:46Z

This integrates debug which can be enabled by setting the environment variable $DEBUG to lint-staged*. It can also be specified inline by doing the following:

# on *nix
$ DEBUG=lint-staged* git commit

# on Windows
λ set DEBUG=lint-staged* && git commit

Example output:

λ node . --debug
  lint-staged:bin Running `[email protected]` +0ms
  lint-staged Loading config using `cosmiconfig` +0ms
  lint-staged Successfully loaded config from `E:\Projects\repos\lint-staged\.lintstagedrc`:
  lint-staged { linters: { '*.js': [ 'eslint --fix', 'git add' ], '.*rc': 'jsonlint' } } +34ms
  lint-staged:cfg Normalizing config +0ms
  lint-staged:cfg Validating config +11ms
Running lint-staged with the following config:
{
  linters: {
    '*.js': [
      'eslint --fix',
      'git add'
    ],
    '.*rc': 'jsonlint'
  },
  concurrent: true,
  chunkSize: 9007199254740991,
  globOptions: {
    matchBase: true,
    dot: true
  },
  subTaskConcurrency: 1,
  renderer: 'verbose'
}
  lint-staged Loaded scripts from package.json:
  lint-staged { precommit: 'remove-lockfiles && node index.js',
  lint-staged   cz: 'git-cz',
  lint-staged   lint: 'eslint .',
  lint-staged   'lint:fix': 'npm run lint -- --fix',
  lint-staged   pretest: 'npm run lint',
  lint-staged   test: 'jest --coverage',
  lint-staged   'test:watch': 'jest --watch' } +80ms
  lint-staged:run Running all linter scripts +0ms
  lint-staged:run Resolved git directory to be `E:\Projects\repos\lint-staged` +4ms
  lint-staged:run Loaded list of staged files in git:
  lint-staged:run [ 'test/runScript.spec.js',
  lint-staged:run   'test/index.spec.js',
  lint-staged:run   'test/getConfig.spec.js',
  lint-staged:run   'test/findBin.spec.js',
  lint-staged:run   'test/__snapshots__/index.spec.js.snap',
  lint-staged:run   'test/__snapshots__/getConfig.spec.js.snap',
  lint-staged:run   'test/__mocks__/my-config.json',
  lint-staged:run   'src/runScript.js',
  lint-staged:run   'src/runAll.js',
  lint-staged:run   'src/index.js',
  lint-staged:run   'src/getConfig.js',
  lint-staged:run   'src/findBin.js',
  lint-staged:run   'index.js',
  lint-staged:run   'README.md' ] +205ms
  lint-staged:gen-tasks Generating linter tasks +0ms
  lint-staged:cfg Normalizing config +322ms
  lint-staged:gen-tasks Generated task:
  lint-staged:gen-tasks { pattern: '*.js',
  lint-staged:gen-tasks   commands: [ 'eslint --fix', 'git add' ],
  lint-staged:gen-tasks   fileList:
  lint-staged:gen-tasks    [ 'E:\\Projects\\repos\\lint-staged\\test\\runScript.spec.js',
  lint-staged:gen-tasks      'E:\\Projects\\repos\\lint-staged\\test\\index.spec.js',
  lint-staged:gen-tasks      'E:\\Projects\\repos\\lint-staged\\test\\getConfig.spec.js',
  lint-staged:gen-tasks      'E:\\Projects\\repos\\lint-staged\\test\\findBin.spec.js',
  lint-staged:gen-tasks      'E:\\Projects\\repos\\lint-staged\\src\\runScript.js',
  lint-staged:gen-tasks      'E:\\Projects\\repos\\lint-staged\\src\\runAll.js',
  lint-staged:gen-tasks      'E:\\Projects\\repos\\lint-staged\\src\\index.js',
  lint-staged:gen-tasks      'E:\\Projects\\repos\\lint-staged\\src\\getConfig.js',
  lint-staged:gen-tasks      'E:\\Projects\\repos\\lint-staged\\src\\findBin.js',
  lint-staged:gen-tasks      'E:\\Projects\\repos\\lint-staged\\index.js' ] } +25ms
  lint-staged:gen-tasks Generated task:
  lint-staged:gen-tasks { pattern: '.*rc', commands: 'jsonlint', fileList: [] } +41ms
Running tasks for *.js [started]
Running tasks for .*rc [started]
  lint-staged:run-script Running script with commands [ 'eslint --fix', 'git add' ] +0ms
  lint-staged:cfg Normalizing config +96ms
Running tasks for .*rc [skipped]
→ No staged files match .*rc
eslint --fix [started]
  lint-staged:find-bin Resolving binary for command `eslint --fix` +0ms
  lint-staged:find-bin Binary for `eslint --fix` resolved to `E:\Projects\repos\lint-staged\node_modules\.bin\eslint.CMD` +50ms
  lint-staged:run-script bin: E:\Projects\repos\lint-staged\node_modules\.bin\eslint.CMD +73ms
  lint-staged:run-script args: [ '--fix',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\test\\runScript.spec.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\test\\index.spec.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\test\\getConfig.spec.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\test\\findBin.spec.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\src\\runScript.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\src\\runAll.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\src\\index.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\src\\getConfig.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\src\\findBin.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\index.js' ] +3ms
  lint-staged:run-script opts: {} +28ms
eslint --fix [completed]
git add [started]
  lint-staged:find-bin Resolving binary for command `git add` +8s
  lint-staged:find-bin Binary for `git add` resolved to `C:\Program Files\Git\cmd\git.EXE` +62ms
  lint-staged:run-script bin: C:\Program Files\Git\cmd\git.EXE +8s
  lint-staged:run-script args: [ 'add',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\test\\runScript.spec.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\test\\index.spec.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\test\\getConfig.spec.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\test\\findBin.spec.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\src\\runScript.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\src\\runAll.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\src\\index.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\src\\getConfig.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\src\\findBin.js',
  lint-staged:run-script   'E:\\Projects\\repos\\lint-staged\\index.js' ] +2ms
  lint-staged:run-script opts: {} +25ms

Edit: Closes #319.

codecov · 2017-11-26T07:47:01Z

Codecov Report

Merging #344 into master will increase coverage by 0.31%.
The diff coverage is 100%.

@@            Coverage Diff            @@
##           master    #344      +/-   ##
=========================================
+ Coverage   97.79%   98.1%   +0.31%     
=========================================
  Files          10      10              
  Lines         181     211      +30     
  Branches       23      23              
=========================================
+ Hits          177     207      +30     
  Misses          4       4

Impacted Files	Coverage Δ
src/getConfig.js	`100% <100%> (ø)`	⬆️
src/generateTasks.js	`100% <100%> (ø)`	⬆️
src/runAll.js	`100% <100%> (ø)`	⬆️
src/runScript.js	`100% <100%> (ø)`	⬆️
src/index.js	`90.47% <100%> (+1.58%)`	⬆️
src/findBin.js	`100% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c22fbc2...b1a228f. Read the comment docs.

okonet · 2017-11-27T10:36:49Z

@sudo-suhas this looks amazing. I'm wondering if we should close #319 in favor of this?

sudo-suhas · 2017-11-27T10:41:54Z

We could. I also felt that debug and verbose have some over lapping functionality. One thing which is missing here is the ability to enable debug logs using a command line flag. If we wanted to, we would need to modify process.env if the flag is present(I think). Thoughts?

okonet · 2017-11-28T11:20:22Z

Overriding the process.env sounds legit to me in case if flag is present. Let's do that!

sudo-suhas · 2017-11-28T11:30:32Z

Okay. Here's what I am going to do:

Remove verbose config option
Use --debug to override process.env and set config.renderer to verbose.

Let me know if you have any concerns or any suggestions.

- Parse command line option `--debug` and enable debug logs if it was passed. - Propagate debug mode - `src/index.js -> runAll -> runScript -> findBin`. - Set npm `--silent` flag using debug mode. - Remove `verbose` from default config, add entry to deprecated options. - Set `listr` renderer using debug mode. - Tweak logs in `src/index.js` depending on debug mode. - Update tests. - Update readme, add section on command line flags. BREAKING CHANGE: `verbose` config option has been deprecated and is superseded by the command line option `--debug`.

luftywiranda13 · 2017-11-30T13:08:15Z

what do you guys think about meow? I use it in some of my CLI projects and I love it

IMO it'll make our jobs easier here

sudo-suhas · 2017-11-30T13:30:52Z

I am not clear on how it is better. In any case, even if we do wish to switch to it, it probably shouldn't be a part of this PR.

okonet · 2017-11-30T13:58:45Z

@sudo-suhas your plan sounds good to me! Please go ahead since I'll need this work in #75

sudo-suhas · 2017-11-30T14:00:41Z

@okonet This PR is ready for a review. I have done the changes we discussed in b1a228f.

sudo-suhas · 2017-11-30T14:02:26Z

Please note that I have marked it as a breaking change in the commit message. We should take care while squashing and merging.

okonet · 2017-11-30T18:16:37Z

Looks good!

okonet · 2017-11-30T18:16:58Z

Please merge it. I’m on my 📱

sudo-suhas · 2017-12-01T04:38:47Z

Merged and release 🎉.

sudo-suhas force-pushed the feat/debug-logs branch from ba93313 to a792a9d Compare November 27, 2017 02:48

okonet previously approved these changes Nov 27, 2017

View reviewed changes

feat: Add debug logs

684e34f

sudo-suhas dismissed okonet’s stale review via 684e34f November 27, 2017 10:44

sudo-suhas force-pushed the feat/debug-logs branch from a792a9d to 684e34f Compare November 27, 2017 10:44

okonet approved these changes Nov 30, 2017

View reviewed changes

sudo-suhas merged commit 8f214f0 into master Dec 1, 2017

sudo-suhas deleted the feat/debug-logs branch December 1, 2017 04:27

dependencies bot mentioned this pull request Dec 27, 2017

Update lint-staged in / from 5.0.0 to 6.0.0 dailybruin/sources#15

Merged

okonet mentioned this pull request Jan 21, 2018

Get rid of advanced config options #277

Closed

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add debug logs #344

feat: Add debug logs #344

sudo-suhas commented Nov 26, 2017 •

edited

Loading

codecov bot commented Nov 26, 2017 •

edited

Loading

okonet commented Nov 27, 2017

sudo-suhas commented Nov 27, 2017

okonet commented Nov 28, 2017

sudo-suhas commented Nov 28, 2017 •

edited

Loading

luftywiranda13 commented Nov 30, 2017

sudo-suhas commented Nov 30, 2017

okonet commented Nov 30, 2017

sudo-suhas commented Nov 30, 2017

sudo-suhas commented Nov 30, 2017

okonet commented Nov 30, 2017

okonet commented Nov 30, 2017

sudo-suhas commented Dec 1, 2017

feat: Add debug logs #344

feat: Add debug logs #344

Conversation

sudo-suhas commented Nov 26, 2017 • edited Loading

codecov bot commented Nov 26, 2017 • edited Loading

Codecov Report

okonet commented Nov 27, 2017

sudo-suhas commented Nov 27, 2017

okonet commented Nov 28, 2017

sudo-suhas commented Nov 28, 2017 • edited Loading

luftywiranda13 commented Nov 30, 2017

sudo-suhas commented Nov 30, 2017

okonet commented Nov 30, 2017

sudo-suhas commented Nov 30, 2017

sudo-suhas commented Nov 30, 2017

okonet commented Nov 30, 2017

okonet commented Nov 30, 2017

sudo-suhas commented Dec 1, 2017

sudo-suhas commented Nov 26, 2017 •

edited

Loading

codecov bot commented Nov 26, 2017 •

edited

Loading

sudo-suhas commented Nov 28, 2017 •

edited

Loading