feat(info): adding more functionality to info package #833

pranshuchittora · 2019-04-17T21:47:58Z

Today, while working on this PR, I observed that many CLI packages have very fewer downloads.

info package downloads

As a developer, I have expected the info package to give some information about config or something related to webpack. Strangely it outputs some environment information.

So the idea is to revamp the current info package by adding a few features.

Information about webpack config. By specifying the path of the webpack config, it will provide some information about plugins, entry point, output point...

Expected behaviour

Solution: By using the power of AST we can parse the config file & get the required details.

Extending the current environment information.
The current env info looks good, but someone might want some other env info, so the idea is to add more env info & access them dynamically by flags.

Multiple flags supported, in order to get multiple env info

Solution: By reading the process arguments (flags)

What kind of change does this PR introduce?
Feature
Did you add tests for your changes?
Yes
If relevant, did you update the documentation?
Yes

I am working on this, so pls suggest any improvements. 🙏
Let's discuss 🔥

a small step towards improving the current info package

for faster and precise execution, a list of supported flags is added

ematipico · 2019-04-18T06:25:41Z

Now that you're proposing some new flags, which are Great, we should also provide an help command/flag so we show how to use the info

anshumanv

Can you also include your .lock file? That should fix the tests. 👍

updates the lock file of packages/info

rishabh3112

Seems to be a good idea to me :) left a change for you.
Also, add [WIP] in the PR title as work is not completed here IMO

packages/info/index.ts

pranshuchittora · 2019-04-18T12:45:14Z

@ematipico check this out.

Help flag

Output formats

JSON

Markdown

Markdown format would make issues to look more cleaner.

Default

evenstensberg

Gonna take this for a spin on a corp project, so chilling this for a bit

anikethsaha · 2019-04-19T15:21:35Z

This one is really great . You can give the command name like describe configfilename much like in kubernetes does to output the state and configuration of the file.

pranshuchittora · 2019-04-19T19:08:20Z

@evenstensberg I am thinking of going with ASTs to extract the required information from the config file. Is there any other way around 😎

ematipico · 2019-04-20T14:08:50Z

@evenstensberg why did you chill a PR that is still WIP?

ematipico

A suggestion

packages/info/index.ts

adds more options and command types

fixed the linting error

packages/info/README.md

ematipico · 2019-06-13T09:38:17Z

packages/info/commands.ts

@@ -0,0 +1,13 @@
+export const AVAILABLE_COMMANDS: string[] = [


You use these constants inside your commands.ts, so you can keep your code DRY.

I am not getting it.

You should create an enum for your available commands.

Later you will use AVAILABLE_COMMANDS.BINARIES inside commands.ts

Basically it's not convenient to have the same string repeated in different places. Create ONE constant and it in those places

ematipico · 2019-06-13T09:40:40Z

packages/info/index.ts

 }
+export default async function info(CustomArgv: object): Promise<void> {
+	const CUSTOM_AGRUMENTS: boolean = typeof CustomArgv === "object";
+	const args: ArgvI = CUSTOM_AGRUMENTS ? CustomArgv : argv;


You define the options using yargs, so could you please use yargs to parse the arguments too? It will keep consistency. Sorry to be annoying but I don't see any reason to not do that

rishabh3112

Few more suggestions

packages/info/README.md

packages/info/package.json

packages/info/renderTable.ts

packages/info/README.md

updates the docs and the package description

removed comments

webpack-bot · 2019-06-13T18:48:48Z

@pranshuchittora Thanks for your update.

I labeled the Pull Request so reviewers will review it again.

@rishabh3112 Please review the new changes.

rishabh3112 · 2019-06-14T00:56:05Z

packages/info/README.md

+yarn add @webpack-cli/info -D
+
+#npx
+npx webpack info [options]


It's not an installation command, it should be under usage :)

now plugin name can be retrived from the constructor call

webpack-bot · 2019-06-25T07:27:56Z

@pranshuchittora Please review the following output log for errors:

Worker information [...]
Build system information [...]
docker stop/waiting [...]
resolvconf stop/waiting [...]


Encrypted environment variables have been removed for security reasons.
See https://docs.travis-ci.com/user/pull-requests/#pull-requests-and-security-restrictions

Setting environment variables from repository settings
$ export nproc=4

Setting environment variables from .travis.yml
$ export JOB_PART=integration


Setting up build cache [...]
$ node --version
v8.16.0
$ npm --version
6.4.1
$ nvm --version
0.34.0

$ npm run travis:lint

> webpack-cli@3.3.5 travis:lint /home/travis/build/webpack/webpack-cli
> npm run build && npm run lint


> webpack-cli@3.3.5 build /home/travis/build/webpack/webpack-cli
> tsc


> webpack-cli@3.3.5 lint /home/travis/build/webpack/webpack-cli
> eslint "./bin/*.js" "./bin/**/*.js" "./test/**/*.js" "packages/**/!(node_modules)/*.ts"  "packages/**/!(node_modules)/**/*.ts"


/home/travis/build/webpack/webpack-cli/packages/info/configParser.ts
  34:26  error    Delete `⏎↹↹`                                   prettier/prettier
  36:3   error    Delete `↹`                                     prettier/prettier
  37:1   error    Delete `↹`                                     prettier/prettier
  37:5   error    'modifyConfig' was used before it was defined  @typescript-eslint/no-use-before-define
  38:1   error    Delete `↹`                                     prettier/prettier
  39:3   error    Delete `↹`                                     prettier/prettier
  40:1   error    Delete `↹`                                     prettier/prettier
  41:1   error    Delete `↹`                                     prettier/prettier
  42:2   error    Replace `↹}⏎↹` with `}`                        prettier/prettier
  48:1   warning  Missing return type on function                @typescript-eslint/explicit-function-return-type
  51:24  warning  Missing return type on function                @typescript-eslint/explicit-function-return-type

/home/travis/build/webpack/webpack-cli/packages/info/index.ts
  63:29  warning  Missing return type on function  @typescript-eslint/explicit-function-return-type

/home/travis/build/webpack/webpack-cli/packages/info/renderTable.ts
   8:11  error  Delete `⏎↹↹`             prettier/prettier
  10:3   error  Delete `↹`               prettier/prettier
  11:2   error  Replace `↹}⏎↹` with `}`  prettier/prettier

/home/travis/build/webpack/webpack-cli/packages/utils/modify-config-helper.ts
  46:4  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any

/home/travis/build/webpack/webpack-cli/packages/webpack-scaffold/index.ts
   51:8   warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
   57:13  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
   90:8   warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
   95:13  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
  108:8   warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
  114:13  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
  127:8   warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
  132:13  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any

✖ 24 problems (12 errors, 12 warnings)
  11 errors and 0 warnings potentially fixable with the `--fix` option.



The command "npm run travis:lint" exited with 1.

$ npm run test:ci

> webpack-cli@3.3.5 test:ci /home/travis/build/webpack/webpack-cli
> nyc jest --maxWorkers=$(nproc) --reporters=default --reporters=jest-junit

 PASS  test/test-utils.test.js
 PASS  packages/webpack-scaffold/__tests__/index.test.ts (7.071s)
 PASS  packages/utils/__tests__/ast-utils.test.ts (9.258s)
 PASS  packages/utils/__tests__/package-manager.test.ts
 PASS  packages/utils/__tests__/resolve-packages.test.ts
 PASS  packages/utils/__tests__/validate-identifier.test.ts
 PASS  packages/info/__tests__/index.test.ts
 PASS  packages/utils/__tests__/recursive-parser.test.ts
 PASS  packages/migrate/commonsChunkPlugin/__tests__/commonsChunkPlugin.test.ts
 PASS  packages/migrate/__tests__/migrate.test.ts
 PASS  test/binCases/help/help-output/help-output.test.js
 PASS  packages/utils/__tests__/npm-packages-exists.test.ts
 PASS  test/binCases/output/output-library-many/output-library-many.test.js
 PASS  test/binCases/env/complex/comple.test.js
 PASS  test/binCases/entry/named-entry/named-entry.test.js
 PASS  test/binCases/output/output-library-single/output-library-single.test.js
 PASS  test/binCases/module/module-bind/module-bind.test.js
 PASS  packages/utils/__tests__/is-local-path.test.ts
 PASS  test/binCases/entry/non-hyphenated-args/non-hyphenated-args.test.js
 PASS  test/binCases/stats/single-config/single-config.test.js
 PASS  test/binCases/entry/multi-file/multi-file.test.js
 PASS  test/binCases/config-name/found-many/found-many.test.js
 PASS  test/binCases/configFile/plugins-precedence/plugins-precedence.test.js
 PASS  test/binCases/config-type/array/array.test.js
 PASS  test/binCases/env/string/string.test.js
 PASS  test/binCases/entry/cli-override/cli-override.test.js
 PASS  test/binCases/errors/info-verbosity/info-verbosity.test.js
 PASS  packages/migrate/loaders/__tests__/loaders.test.ts
 PASS  packages/generators/__tests__/add-generator.test.ts
 PASS  test/binCases/config-name/found-one/found-one.test.js

Please remove deprecated plugins manually. 
See https://webpack.js.org/guides/migrating/ for more information.
Please remove deprecated plugins manually. 
See https://webpack.js.org/guides/migrating/ for more information.
Please remove deprecated plugins manually. 
See https://webpack.js.org/guides/migrating/ for more information. PASS  packages/migrate/removeDeprecatedPlugins/__tests__/removeDeprecatedPlugins.test.ts
 PASS  test/binCases/errors/parse/parse.test.js
 PASS  test/binCases/errors/clean-webpack-options/clean-webpack-options.test.js
 PASS  test/binCases/config-location/set-explicitly/set-explicitly.test.js
 PASS  test/binCases/config-type/invalid-array/invalid-array.test.js
 PASS  test/binCases/config-type/invalid-type/invalid-type.test.js
 PASS  packages/generators/__tests__/loader-generator.test.ts
 PASS  test/binCases/config-location/webpackfile-config/packages/foo/webpackfile-config.test.js
 PASS  test/binCases/stats/custom-preset/custom-preset.test.js
 PASS  test/binCases/config-type/function-promise/function-promise.test.js
 PASS  test/binCases/output/output-argument/output-argument.test.js
 PASS  test/binCases/config-type/function/function.test.js
 PASS  test/binCases/config-type/promise/promise.test.js
 PASS  packages/migrate/uglifyJsPlugin/__tests__/uglifyJsPlugin.test.ts
 PASS  test/binCases/config-type/object/object.test.js
 PASS  test/binCases/mode/none/none.test.js
 PASS  test/binCases/config-location/find-recursively/packages/foo/find-recursively.test.js
 PASS  packages/migrate/loaderOptionsPlugin/__tests__/loaderOptionsPlugin.test.ts
 PASS  packages/utils/__tests__/npm-exists.test.ts
 PASS  test/binCases/config-location/set-implicitly/set-implicitly.test.js
 PASS  test/binCases/no-options/production/production.test.js
 PASS  test/binCases/stats/build-delimiter/build-delimiter.test.js
 PASS  test/binCases/config-name/not-found/not-found.test.js
 PASS  packages/migrate/removeJsonLoader/__tests__/removeJsonLoader.test.ts
 PASS  test/binCases/config-location/not-found/not-found.test.js
 PASS  packages/migrate/moduleConcatenationPlugin/__tests__/moduleConcatenationPlugin.test.ts
 PASS  test/binCases/no-options/none/none.test.js
 PASS  test/binCases/errors/issue-5576/issue-5576.test.js
 PASS  packages/migrate/noEmitOnErrorsPlugin/__tests__/noEmitOnErrorsPlugin.test.ts
 PASS  packages/migrate/namedModulesPlugin/__tests__/namedModulesPlugin.test.ts
 PASS  test/binCases/configFile/profile/profile.test.js
 PASS  test/binCases/entry/display-entrypoints/display-entrypoints.test.js
 PASS  test/binCases/stats/multi-config/multi-config.test.js
 PASS  test/binCases/silent/silent-output/silent.test.js
 PASS  packages/migrate/bannerPlugin/__tests__/bannerPlugin.test.ts
 PASS  packages/migrate/outputPath/__tests__/outputPath.test.ts
 PASS  test/binCases/stats/none/none.test.js
 PASS  packages/migrate/extractTextPlugin/__tests__/extractTextPlugin.test.ts
 PASS  packages/migrate/resolve/__tests__/resolve.test.ts
 PASS  test/binCases/config-location/webpack-babel-config/webpack-babel-config.test.js (19.837s)
�[999D�[K
Test Suites: 8 skipped, 70 passed, 70 of 78 total
Tests:       8 skipped, 197 passed, 205 total
Snapshots:   95 passed, 95 total
Time:        87.169s
Ran all test suites.
The command "npm run test:ci" exited with 0.

store build cache [...]

Done. Your build exited with 1.

See complete report here.

evenstensberg · 2019-07-22T20:50:17Z

Could you rebase this against the next branch?

pranshuchittora · 2019-07-24T18:00:02Z

Refer #1007

feat(info): adding more functionality and improves performance

242c613

a small step towards improving the current info package

webpack-bot added the PR: unreviewed label Apr 17, 2019

feat(info): adds the list of supported flags

d52396b

for faster and precise execution, a list of supported flags is added

anshumanv requested changes Apr 18, 2019

View reviewed changes

webpack-bot added PR: reviewed-changes-requested and removed PR: unreviewed labels Apr 18, 2019

chore(depen): updates the package-lock of info package

754ad92

updates the lock file of packages/info

webpack-bot added PR: review-outdated and removed PR: reviewed-changes-requested labels Apr 18, 2019

rishabh3112 requested changes Apr 18, 2019

View reviewed changes

packages/info/index.ts Outdated Show resolved Hide resolved

webpack-bot added PR: reviewed-changes-requested PR: CI-ok and removed PR: review-outdated labels Apr 18, 2019

evenstensberg reviewed Apr 18, 2019

View reviewed changes

evenstensberg added the Chill ❄️ label Apr 18, 2019

pranshuchittora changed the title ~~feat(info): adding more functionality to info package~~ [WIP] feat(info): adding more functionality to info package Apr 19, 2019

ematipico suggested changes Apr 20, 2019

View reviewed changes

packages/info/index.ts Outdated Show resolved Hide resolved

feat(info): adds different command types and options

2f31b5b

adds more options and command types

webpack-bot added PR: review-outdated PR: CI-not-ok and removed PR: reviewed-changes-requested PR: CI-ok labels Apr 20, 2019

chore(info): fixes the linting

2badfd1

fixed the linting error

webpack-bot added PR: CI-ok and removed PR: CI-not-ok labels Apr 20, 2019

ematipico reviewed Jun 13, 2019

View reviewed changes

rishabh3112 requested changes Jun 13, 2019

View reviewed changes

webpack-bot added PR: reviewed-changes-requested and removed PR: review-outdated labels Jun 13, 2019

pranshuchittora added 2 commits June 14, 2019 00:16

chore(docs): updates description and docs

83f038c

updates the docs and the package description

chore(comments): removes unwanted comments

b3c98ad

removed comments

webpack-bot added PR: review-outdated and removed PR: reviewed-changes-requested labels Jun 13, 2019

rishabh3112 requested changes Jun 14, 2019

View reviewed changes

webpack-bot added PR: reviewed-changes-requested and removed PR: review-outdated labels Jun 14, 2019

feat(info): adds support for plugin name from the parsed config

4b3105f

now plugin name can be retrived from the constructor call

webpack-bot added PR: review-outdated and removed PR: reviewed-changes-requested labels Jun 17, 2019

Merge branch 'master' of github.com:webpack/webpack-cli into info

8843786

webpack-bot added PR: CI-not-ok and removed PR: CI-ok labels Jun 17, 2019

pranshuchittora added 3 commits June 25, 2019 12:34

Merge branch 'master' of github.com:webpack/webpack-cli into info

2e9c758

chore(files): undo the changes in migrate

479df8d

chore(init): undo file changes in init

5e043b9

evenstensberg added 2 commits July 14, 2019 15:01

chore: fix sec vuln

110fa5e

chore: v3.3.6

a56e916

ematipico changed the base branch from master to next July 23, 2019 07:14

Merge branch 'master' of github.com:webpack/webpack-cli into info

d14d878

pranshuchittora mentioned this pull request Jul 24, 2019

feat(info): new features #1007

Merged

pranshuchittora closed this Jul 24, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(info): adding more functionality to info package #833

feat(info): adding more functionality to info package #833

pranshuchittora commented Apr 17, 2019 •

edited

ematipico commented Apr 18, 2019

anshumanv left a comment

rishabh3112 left a comment

pranshuchittora commented Apr 18, 2019

evenstensberg left a comment

anikethsaha commented Apr 19, 2019

pranshuchittora commented Apr 19, 2019 •

edited

ematipico commented Apr 20, 2019

ematipico left a comment

ematipico Jun 13, 2019

pranshuchittora Jun 13, 2019

ematipico Jun 13, 2019

ematipico Jun 13, 2019

rishabh3112 left a comment •

edited

webpack-bot commented Jun 13, 2019

rishabh3112 Jun 14, 2019

webpack-bot commented Jun 25, 2019

evenstensberg commented Jul 22, 2019

pranshuchittora commented Jul 24, 2019

		@@ -0,0 +1,13 @@
		export const AVAILABLE_COMMANDS: string[] = [

feat(info): adding more functionality to info package #833

feat(info): adding more functionality to info package #833

Conversation

pranshuchittora commented Apr 17, 2019 • edited

ematipico commented Apr 18, 2019

anshumanv left a comment

Choose a reason for hiding this comment

rishabh3112 left a comment

Choose a reason for hiding this comment

pranshuchittora commented Apr 18, 2019

Output formats

evenstensberg left a comment

Choose a reason for hiding this comment

anikethsaha commented Apr 19, 2019

pranshuchittora commented Apr 19, 2019 • edited

ematipico commented Apr 20, 2019

ematipico left a comment

Choose a reason for hiding this comment

ematipico Jun 13, 2019

Choose a reason for hiding this comment

pranshuchittora Jun 13, 2019

Choose a reason for hiding this comment

ematipico Jun 13, 2019

Choose a reason for hiding this comment

ematipico Jun 13, 2019

Choose a reason for hiding this comment

rishabh3112 left a comment • edited

Choose a reason for hiding this comment

webpack-bot commented Jun 13, 2019

rishabh3112 Jun 14, 2019

Choose a reason for hiding this comment

webpack-bot commented Jun 25, 2019

evenstensberg commented Jul 22, 2019

pranshuchittora commented Jul 24, 2019

pranshuchittora commented Apr 17, 2019 •

edited

pranshuchittora commented Apr 19, 2019 •

edited

rishabh3112 left a comment •

edited