@digest/scripts

Helper scripts for various digests

Stats

StarsIssuesVersionUpdatedCreatedSize
@digest/scripts
3.1.162 months ago3 years agoMinified + gzip package size for @digest/scripts in KB

Readme

Digest Crane

@digest/scripts

Commitizen Friendly Semantic Release
Build Status Coverage Report NPM Version License Canonical Code Style

@digest/scripts shared scripts for the other @digest projects to function. These include a configuration loader to catch the following user parameters and a resolver to properly require various default and user determined files.

This package should not need to be required explicitly.

This is the master list of managed properties.

digest.config.js Environment Variable Description Default Options
n/a NODE_ENV Use either production or development. Production features include minification, while development features include linting and HMR. production [production|development]
n/a DIGEST Path to @digest settings. It contains these settings and more. /digest.config.js
n/a PORT The express host port Default 8080, 8090 when NODE_ENV='development'
angular ANGULAR Enable/Disable Angular required Babel plugins, Webpack loaders, and library entries true if @digest/angular is included in package.json dependencies; otherwise false [true|false]
appHost APP_HOST The express server host default host value
babel BABEL Path to Babel configuration file or false to disable /.babelrc, or @digest/babel provided configuration file if included in package.json dependencies, otherwise false [PATH|false]
baseHref BASE_HREF Set the provided default index.html base href path, e.g. <base href=''>. Also used by provided express and workbox configs. /
cache CACHE Path to store temporary cache files /node_modules/.cache/
compression COMPRESSION Enable file compression and attempt to serve compressed files. true [true|false]
config CONFIG Path to Webpack config. /webpack.config.js, or @digest/webpack provided config
cssModules CSS_MODULES Enables CSS modules in Webpack and Babel false [true|false]
dashboard DASHBOARD Use webpack-dashboard true [true|false]
e2e E2E Path to end-to-end test files for Nightwatch /__e2e__
env ENV A json object that defines environment variables to be included by Webpack DefinePlugin. For example, {"open": "\"sets\""}. Accessible under process.env. {}
eslint ESLINT Path to JavaScript ESLint configuration file /.eslintrc, or @digest/eslint-config provided configuration file if included in package.json dependencies, otherwise false [PATH|false]
favicon FAVICON Path to favicon.png /SRC_PATH/favicon.png or default favicon packaged with @digest/webpack
flow FLOW Enable/Disable FlowType Babel preset true if @digest/flow is included in package.json dependencies; otherwise false [true|false]
graphql GRAPHQL Enable/Disable GraphQL Babel plugin and Webpack file loader true if @digest/graphql is included in package.json dependencies; otherwise false [true|false]
graphqlSchema GRAPHQL_SCHEMA Path to GraphQL schema.json /schema.json
headless HEADLESS Whether to run browsers in headless mode in selenium true [true|false]
host HOST The default host 127.0.0.1
index INDEX Path to index.htm /SRC_PATH/index.htm or default index.htm packaged with @digest/webpack
jestSetup JEST_SETUP Path to Jest setup file /jest.setup.json, or @digest/jest provided configuration file if included in package.json dependencies
library LIBRARY Toggle UMD library creation instead. This generates a bundle without dependencies and polyfills false [true|false]
minimize MINIMIZE Enable/Disable minification. Can be useful when wanting to both copies for publishing. true [true|false]
parallel PARALLEL Whether to run loaders in parallel or not. Parallel will only use the maximum processors minus two; but can be disabled altogether if issues still arise true [true|false]
polyfills POLYFILLS Path to additional polyfills /polyfills.js
postcss POSTCSS Path to PostCSS config /postcss.config.js, or @digest/postcss provided configuration file if included in package.json dependencies, otherwise false [PATH|false]
postcssWhitelist POSTCSS_WHITELIST A pipe separated whitelist of packages in node_modules that should be parsed by PostCSS react-toolbox
pwa PWA Includes Workbox entries in Webpack build true if @digest/webpack-workbox is included in package.json dependencies; otherwise false [true|false]
react REACT Enable/Disable React Babel preset and other related plugins true if @digest/react is included in package.json dependencies; otherwise false [true|false]
reportPath REPORT_PATH Path to generate reports /reports
scss SCSS Enable/Disable SCSS Webpack loader true if @digest/scss is included in package.json dependencies; otherwise false [true|false]
seleniumChromeDriver SELENIUM_CHROME_DRIVER The Selenium Chrome driver version
seleniumDriver SELENIUM_DRIVER The Selenium driver version
seleniumGeckoDriver SELENIUM_GECKO_DRIVER The Selenium Firefox/Gecko driver version
seleniumHost SELENIUM_HOST The Selenium server host default host value
seleniumPort SELENIUM_PORT The Selenium server port 4444
seleniumStart SELENIUM_START Whether to start Selenium or not; for CI integration. true
shortName SHORT_NAME An optional shorter name to be used in bundle generation. Useful when generating libraries. The name property in package.json
sourceMaps SOURCE_MAPS Toggle source map generation true [true|false]
srcPath SRC_PATH Path to project files directory relative to project root /src
staticPath STATIC_PATH Path to directory where Webpack will deposit the resulting project relative to project root /public
stylelint STYLELINT Path to CSS stylelint configuration file or false to disable /.stylelintrc, or @digest/stylelint-config provided configuration file if included in package.json dependencies, otherwise false [PATH|false]
stylelintIgnore STYLELINT_IGNORE Path to CSS stylelint ignore file /.stylelintignore or default .stylelintignore packaged with @digest/stylelint-config
typescript TYPESCRIPT Path to TypeScript configuration file or false to disable /tsconfig.json, or @digest/typescript provided configuration file if included in package.json dependencies, otherwise false [PATH|false]

License

GPLv3

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.