@cmmn/tools 1.4.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +3 -3
  2. package/readme.md +26 -6
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@cmmn/tools",
3
- "version": "1.4.0",
4
- "description": "di, base extensions, useful functions",
3
+ "version": "1.4.1",
4
+ "description": "Compilation, bundling, code generator, testing.",
5
5
  "main": "dist/rollup.config.js",
6
6
  "type": "module",
7
7
  "publishConfig": {
@@ -65,5 +65,5 @@
65
65
  },
66
66
  "author": "",
67
67
  "license": "ISC",
68
- "gitHead": "824d290afabaa3a44ccb98322cb1758825bd9efb"
68
+ "gitHead": "d1405a0626569d43adc867fe660f4df8b5c3b492"
69
69
  }
package/readme.md CHANGED
@@ -1,11 +1,31 @@
1
1
  ## Builder and bundler for your projects
2
2
 
3
3
  ### Use cases:
4
- `cmmn compile [target] [-b] [--watch]`
5
- > Runs typescript compiler
4
+ * `cmmn compile [target] [-b] [--watch]`
5
+ > Runs typescript compiler
6
6
 
7
- `cmmn bundle [target] [-b] [--watch] [--run] [--prod]`
8
- > Runs rollup bundler
7
+ * `cmmn bundle [target] [-b] [--watch] [--run] [--prod]`
8
+ > Runs rollup bundler
9
9
 
10
- `cmmn gen name directory [-n]`
11
- > Generates component with template at directory
10
+ * `cmmn gen name directory [-n]`
11
+ > Generates component with template at directory
12
+
13
+ * default `jest.config.js`:
14
+ ```typescript
15
+ import config from "@cmmn/tools/test/config";
16
+ export default config;
17
+ ```
18
+
19
+ * tests: `some.spec.ts`
20
+ ```typescript
21
+ import {suite, test, expect} from "@cmmn/tools/test";
22
+
23
+ @suite
24
+ export class SomeSpec {
25
+
26
+ @test
27
+ equalsTest() {
28
+ expect(1).toBe(2);
29
+ }
30
+ }
31
+ ```