@ayapapa-npm/contracts-js 0.4.0 → 0.4.2

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.
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
1
  [![CI](https://github.com/ayapapa/contracts-js/actions/workflows/ci.yml/badge.svg)](https://github.com/ayapapa/contracts-js/actions/workflows/ci.yml)
2
- ![Coverage](https://raw.githubusercontent.com/ayapapa/pretty-console-js/main/badges/coverage-total.svg)
3
- ![Branches](https://raw.githubusercontent.com/ayapapa/pretty-console-js/main/badges/coverage-branches.svg)
4
- ![Functions](https://raw.githubusercontent.com/ayapapa/pretty-console-js/main/badges/coverage-functions.svg)
5
- ![Lines](https://raw.githubusercontent.com/ayapapa/pretty-console-js/main/badges/coverage-lines.svg)
6
- ![Statements](https://raw.githubusercontent.com/ayapapa/pretty-console-js/main/badges/coverage-statements.svg)
2
+ ![Coverage](https://raw.githubusercontent.com/ayapapa/contracts-js/main/badges/coverage-total.svg)
3
+ ![Branches](https://raw.githubusercontent.com/ayapapa/contracts-js/main/badges/coverage-branches.svg)
4
+ ![Functions](https://raw.githubusercontent.com/ayapapa/contracts-js/main/badges/coverage-functions.svg)
5
+ ![Lines](https://raw.githubusercontent.com/ayapapa/contracts-js/main/badges/coverage-lines.svg)
6
+ ![Statements](https://raw.githubusercontent.com/ayapapa/contracts-js/main/badges/coverage-statements.svg)
7
7
 
8
8
  # contracts-js
9
9
  A lightweight Design by Contract library for JavaScript.</br>
@@ -133,7 +133,7 @@ Contracts.INVARIANT(
133
133
  ```
134
134
 
135
135
  ## API Reference
136
- [API document](docs/api.md)
136
+ [API document](https://raw.githubusercontent.com/ayapapa/contracts-js/main/docs/api.md)
137
137
 
138
138
  ## Usage
139
139
 
package/dist/index.cjs CHANGED
@@ -30,7 +30,11 @@ var Contracts = class _Contracts {
30
30
  /**
31
31
  * Static fields
32
32
  */
33
- /** Debug mode state */
33
+ /**
34
+ * Debug mode state.<br>
35
+ * **Note: This property is retained for backward compatibility.<br>
36
+ * Please use `setConfig()` to change the debug mode.**
37
+ */
34
38
  static DEBUG_MODE = false;
35
39
  /** default configuration */
36
40
  static #defaultConf = {
package/dist/index.d.cts CHANGED
@@ -62,7 +62,11 @@ declare class Contracts {
62
62
  /**
63
63
  * Static fields
64
64
  */
65
- /** Debug mode state */
65
+ /**
66
+ * Debug mode state.<br>
67
+ * **Note: This property is retained for backward compatibility.<br>
68
+ * Please use `setConfig()` to change the debug mode.**
69
+ */
66
70
  static DEBUG_MODE: boolean;
67
71
  /** logger */
68
72
  /**
package/dist/index.d.ts CHANGED
@@ -62,7 +62,11 @@ declare class Contracts {
62
62
  /**
63
63
  * Static fields
64
64
  */
65
- /** Debug mode state */
65
+ /**
66
+ * Debug mode state.<br>
67
+ * **Note: This property is retained for backward compatibility.<br>
68
+ * Please use `setConfig()` to change the debug mode.**
69
+ */
66
70
  static DEBUG_MODE: boolean;
67
71
  /** logger */
68
72
  /**
package/dist/index.js CHANGED
@@ -3,7 +3,11 @@ var Contracts = class _Contracts {
3
3
  /**
4
4
  * Static fields
5
5
  */
6
- /** Debug mode state */
6
+ /**
7
+ * Debug mode state.<br>
8
+ * **Note: This property is retained for backward compatibility.<br>
9
+ * Please use `setConfig()` to change the debug mode.**
10
+ */
7
11
  static DEBUG_MODE = false;
8
12
  /** default configuration */
9
13
  static #defaultConf = {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ayapapa-npm/contracts-js",
3
- "version": "0.4.0",
3
+ "version": "0.4.2",
4
4
  "description": "A lightweight Design by Contract library for JavaScript.",
5
5
  "license": "MIT",
6
6
  "author": "ayapapa",
@@ -18,6 +18,7 @@
18
18
  ],
19
19
  "scripts": {
20
20
  "build": "tsup src/index.ts --format esm,cjs --out-dir dist --clean --dts",
21
+ "build:doc": "npx typedoc && node scripts/rename-docs.cjs",
21
22
  "typecheck": "tsc --noEmit",
22
23
  "test": "vitest run",
23
24
  "test:debug": "vitest --inspect-brk --run",
@@ -26,8 +27,7 @@
26
27
  "coverage": "vitest run --coverage",
27
28
  "coverage:ui": "vitest run --coverage && start coverage/index.html",
28
29
  "check": "npm run typecheck && npm run build && npm run test",
29
- "release:check": "npm run check",
30
- "prepublishOnly": "npm run release:check"
30
+ "prepublishOnly": "npm run check"
31
31
  },
32
32
  "devDependencies": {
33
33
  "@types/node": "^26.2.0",