@01-edu/shared 1.0.6 → 1.0.12
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 +27 -1
- package/attrs-defs.js +412 -115
- package/attrs.js +102 -15
- package/bin/check-definitions.js +8 -0
- package/definitions-checker.js +25 -23
- package/onboarding.js +1 -0
- package/package.json +2 -2
- package/path.js +18 -8
- package/toolbox.js +32 -9
package/README.md
CHANGED
|
@@ -1,5 +1,31 @@
|
|
|
1
1
|
# 01-Edu shared library
|
|
2
2
|
|
|
3
|
-
## `check-
|
|
3
|
+
## `check-defs` command
|
|
4
4
|
|
|
5
|
+
Script used to validate content correctness.
|
|
5
6
|
|
|
7
|
+
It check the overall structure, attributes and other properties in definitions
|
|
8
|
+
|
|
9
|
+
It also check the existance of needed `README.md` files
|
|
10
|
+
|
|
11
|
+
### Usage:
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
# Ensure your current working directory is the repository you want to check
|
|
15
|
+
cd piscine-test
|
|
16
|
+
|
|
17
|
+
# Normal usage
|
|
18
|
+
npx -y -p '@01-edu/shared' check-defs
|
|
19
|
+
|
|
20
|
+
# Pinned version
|
|
21
|
+
npx -y -p '@01-edu/shared@v1.0.6' check-defs
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
#### `-w`, `--watch` param
|
|
25
|
+
|
|
26
|
+
Will re-check on system events (new, updated, removed files)
|
|
27
|
+
Never exit, just keep waiting for changes to update the report
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
npx -y -p '@01-edu/shared' check-defs --watch
|
|
31
|
+
```
|