@dash4/config

Dash4 config

Set of configurations and scripts for creating a `Dash4 Plugin`.

The following documentation is just relevant for dash4 plugin development. For informations on how to use Dash4 please read this: Dash4 documentation

Table of Contents

• Installation
• Usage
• License

Installation

npm i -D @dash4/server @dash4/config cross-env nodemon rimraf typescript webpack @types/jest jest ts-jest @testing-library/react

Usage

package.json

{
  "scripts": {
    "analyze-bundle-size": "cross-env NODE_ENV=production ANALYZE_ENV=bundle webpack --mode production",
    "prebuild": "rimraf build dist",
    "build": "npm-run-all build:*",
    "build:client": "cross-env NODE_ENV=production webpack --mode production",
    "build:server": "tsc --outDir build --project tsconfig.server.json",
    "prepublishOnly": "npm-run-all test build",
    "start": "cross-env NODE_ENV=development nodemon ./node_modules/@dash4/server/bin --watch ./build --watch ./dash4.config.js",
    "static": "node ./node_modules/@dash4/server/bin",
    "test": "npm-run-all test:*",
    "test:client": "jest --coverage --config=jest.config.js",
    "test:server": "jest --coverage --config=jest.server.config.js",
    "watch-build": "tsc --watch --outDir build --project tsconfig.server.json",
    "watch-dist": "cross-env NODE_ENV=development webpack --mode production --watch",
    "watch-test-client": "jest --coverage --watchAll --config=jest.config.js",
    "watch-test-server": "jest --coverage --watchAll --config=jest.server.config.js"
  }
}

tsconfig.json

{
  "extends": "@dash4/config/tsconfig.json",
  "exclude": ["dist", "build", "node_modules", "__tests__", "src/server"]
}

tsconfig.test.json

{
  "extends": "@dash4/config/tsconfig.test.json",
  "exclude": ["dist", "build", "node_modules", "__tests__", "src/server"]
}

tsconfig.server.json

{
  "extends": "@dash4/config/tsconfig.server.json",
  "exclude": ["dist", "build", "node_modules", "__tests__", "src/client"]
}

jest.config.js

module.exports = require('@dash4/config/jest.config');

jest.server.config.js

module.exports = require('@dash4/config/jest.server.config');

webpack.config.js

module.exports = require('@dash4/config/webpack.config.js')('###PLUGIN_NAME###');

License

The @dash4/config is MIT licensed

Changelog

<small>0.9.3 (2020-12-07)</small>

• fix: update dependencies (4a41e32)
• chore: switch to node 14.15.1 (93df8c3)