@yamato-daiwa/style_guides 0.3.0 → 0.3.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/README.md +18 -4
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -20,13 +20,27 @@ npm i @yamato-daiwa/style_guides -D -E
20
20
 
21
21
  ### Usage
22
22
  #### Extending of ESLint preset
23
+ ##### CommonJS
23
24
 
24
- For the **.eslintrc.yaml** case, it will be:
25
+ ```js
26
+ const YamatoDaiwaStyleGuides = require("@yamato-daiwa/style_guides/ECMAScript");
25
27
 
26
- ```yaml
27
- extends: ./node_modules/@yamato-daiwa/style_guides/ECMAScript.js
28
+
29
+ module.exports = [
30
+ ...YamatoDaiwaStyleGuides
31
+ ];
28
32
  ```
29
33
 
34
+ ##### ES Modules
35
+
36
+ ```js
37
+ import YamatoDaiwaStyleGuides from "@yamato-daiwa/style_guides/ECMAScript";
38
+
39
+
40
+ export default [
41
+ ...YamatoDaiwaStyleGuides
42
+ ];
43
+ ```
30
44
 
31
45
  #### Extending of pug-lint preset
32
46
 
@@ -38,7 +52,7 @@ For the **.pug-lintrc** case, it will be:
38
52
  }
39
53
  ```
40
54
 
41
- Depending on the project building tool, the excluding of **node_modules** could require.
55
+ Depending on the project building tool, the excluding of **node_modules** may require.
42
56
 
43
57
  ```json
44
58
  {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yamato-daiwa/style_guides",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "The guidelines for ESLint, Pug and Stylus.",
5
5
  "engines": {
6
6
  "node": ">=18.18.0"