Skip to content

Instantly share code, notes, and snippets.

@Smolations

Smolations/elmer_help.md

Created September 22, 2017 22:27
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save Smolations/f5553aeffa0e22635fac202060ed0fc5 to your computer and use it in GitHub Desktop.
Save Smolations/f5553aeffa0e22635fac202060ed0fc5 to your computer and use it in GitHub Desktop.
Download ZIP
`npm run help` in elmer
Raw
elmer_help.md 
$ npm run help

> @tangogroup/elmer@1.0.0 help /home/vagrant/polymer/elmer
> npm run & gulp help

Lifecycle scripts included in @tangogroup/elmer:
  start
    webpack-dev-server --config webpack.toolkit.config.js --open
  test
    gulp test

available via `npm run-script`:
  install-build
    npm install && npm run build
  build
    webpack --config webpack.config.js --progress --display-error-details --env.production
  build:components
    webpack --config webpack.elmer.config.js --progress --display-error-details
  build:toolkit
    webpack --config webpack.toolkit.config.js --progress --display-error-details
  start:dashboard
    webpack-dashboard -- webpack-dev-server --config webpack.toolkit.config.js --open --env.dashboard
  gen
    yo elmer-component
  lint
    gulp test:eslint
  lint:fix
    gulp test:eslint-fix
  gulp
    gulp
  help
    npm run & gulp help


Usage: npm run <npmScript> -- [options]
Usage: npm start -- [options]
Usage: npm run gulp <gulpTask(s)>          (options have no effect)

Options:
  --help            Show help                                          [boolean]
  --version         Show version number                                [boolean]
  --env.production  Enable settings for production builds. This includes making
                    sourcemaps in separate files and adding processing plugins
                    like UglifyJS. See the webpack configs for more info.
                                                      [boolean] [default: false]
  --env.debug       Turns on verbose logging for ALL plugins. Also enables
                    plugin for dev server to ensure rebuilt files can be seen in
                    the dist folder.                  [boolean] [default: false]
  --env.epoxy       Primarily for use with the dev server, this ensures that
                    build artifacts for epoxy get built.
                                                      [boolean] [default: false]
  --env.lint        Only applicable to dev server, this turns on linting for
                    file changes. On its own, it will only lint js files. In
                    order to lint spec files, the --env.test option must also be
                    passed.                           [boolean] [default: false]
  --env.test        Only applicable to dev server, this turns on spec file
                    testing for file changes. If a spec file changes, that spec
                    file is tested. If a component file changes, any spec files
                    within the same folder are tested.[boolean] [default: false]

Examples:
  $ npm run gen                             Run the interactive generator for
                                            components to create a new
                                            component, filter, or service.
  $ npm run build                           Builds toolkit bundle, components
                                            bundle, and components sass so that
                                            all can be seen/used in epoxy. Epoxy
                                            styles will need to be recompiled to
                                            see style changes.
  $ npm run build:components                Builds the component bundle to be
                                            used in epoxy with inline sourcemaps
                                            and without uglifying the code.
  $ npm run build:components --             Builds a production version of the
  --env.production                          components bundle, completely
                                            minified, including a separate
                                            sourcemap.
  $ npm start                               Starts the dev server. This mode
                                            simply watches for
                                            toolkit/components changes in the
                                            module tree and rebundles. No
                                            linting, tests, or minification is
                                            performed.
  $ npm run start-dashboard                 This is the only way to enable the
                                            spiffy dev server dashboard. Give it
                                            a try to see what it does!
  $ npm start -- --env.test                 Enable test mode while running the
                                            dev server. Any time a spec file is
                                            changed, it will be tested. Any time
                                            component code is changed, any
                                            related spec files will be tested.
  $ npm start -- --env.lint --env.test      In addition to enabling tests, js
  --env.epoxy                               files will be linted. Because test
                                            mode is enabled, spec files will
                                            also be linted. This mode will also
                                            build the components bundle and
                                            components sass so that epoxy has
                                            access to the updated files every
                                            time there is a change to component
                                            styles/js.
  $ npm test                                Run the full test suite.

[22:23:14] Using gulpfile ~/polymer/elmer/gulpfile.js
[22:23:14] Starting 'help'...

Usage
  gulp [TASK] [OPTIONS...]

Available tasks
  doc-gen                 generate js files used for toolkit docs
  elmer:build:icons       builds the icon svg sprite [elmer:build:icons:json]
  elmer:build:icons:json  builds a JSON file with an array of all icons
  elmer:resourcemask      builds language mask file
  elmer:resources         copies resource files to dist [elmer:resourcemask]
  help                    Display this help text.
  test                    run all tests [test:js, test:eslint, test:resources]
  test:debug              not sure what this is for. lil help?
  test:eslint             lints all js files
  test:eslint-fix         automatically fixes any linting errors found
  test:js                 just run karma tests on the js [elmer:build:icons, test:js:x-large, test:js:large, test:js:medium, test:js:small, test:js:x-small]
  test:js:large           just run tests targeting browsers of the large variety
  test:js:medium          just run tests targeting browsers of the medium variety
  test:js:small           just run tests targeting browsers of the small variety
  test:js:x-large         just run tests targeting browsers of the x-large variety
  test:js:x-small         just run tests targeting browsers of the x-small variety
  test:resources          ensures that language resource files do not have duplicate keys

[22:23:14] Finished 'help' after 8.72 ms
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment