docs(contributing): add packages and development worlflow (#836)

This commit is contained in:
Li Kang
2022-05-30 19:06:27 +02:00
committed by GitHub
parent 50fdefa9c7
commit ff1aa8ad70
4 changed files with 17 additions and 11 deletions

View File

@@ -37,6 +37,11 @@ This is a multi-package repository which uses [lerna](https://github.com/lerna/l
- `nucleus`: JavaScript library for mashups
- `supernova`: JavaScript API for consuming and visualizing QIX data
- `stardust`: Public JavaScript API which exposes the nucleus and supernova APIs
- `enigma-mocker`: Public JavaScript API which creates a mocked enigma app to renders visualizations without a connected Qlik engine
- `snapshooter`: Public JavaScript API which captures rendered charts as images
- `conversion`: [private] Provides conversion functionality to extensions with hyperCubes.
- `theme`: [private] Access/consume the currently applied theme
- `locale`: [private] Handle translation string to generate all locales
- `commands` - CLI commands
- `build`: cli command to build a supernova
- `cli`: entry point for all cli commands
@@ -49,9 +54,10 @@ This is a multi-package repository which uses [lerna](https://github.com/lerna/l
### Development workflow
- `yarn` generates UMD bundles for all packages
- `yarn run build`
- `yarn` install all dependencies
- `yarn run build` generates UMD bundles for all packages and a ESM bundle for stardust
- `yarn run lint` checks code style
- `yarn run format` format code style
- `yarn run test` runs all tests
### Cutting a release

View File

@@ -1,5 +1,5 @@
module.exports = ({ config }) => {
const jsRule = config.module.rules.find(rule => rule.test.test('.js'));
const jsRule = config.module.rules.find((rule) => rule.test.test('.js'));
jsRule.exclude = /node_modules/;
return config;

View File

@@ -3,6 +3,7 @@
The English resource (string) container [`en-US.json`](./en-US.json) on `master` is monitored for changes. All modifications will automatically be picked up and propagated to the other locale files by the Globalization Services team at Qlik at regular intervals (weekly).
## Pull requests touching English string resources
Please add [dechabot (Dan Chabot)](https://github.com/dechabot) for review on all PRs touching [English string resources](./en-US.json), to ensure changes are consistent with style guides and translatability requirements.
**Important**

View File

@@ -4,12 +4,11 @@ const yargs = require('yargs');
const mashupServer = require('../test/mashup/server');
const args = yargs
.option('start', {
const args = yargs.option('start', {
default: true,
type: 'boolean',
describe: 'Start the mashup server',
}).argv;
}).argv;
const { start } = args;