mikey-pro 9.0.1 → 9.0.6

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 +1 -1
  2. package/README.md +0 -148
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "mikey-pro",
3
- "version": "9.0.1",
3
+ "version": "9.0.6",
4
4
  "description": "Mikey Pro Style Guide",
5
5
  "type": "module",
6
6
  "dependencies": {
package/README.md DELETED
@@ -1,148 +0,0 @@
1
- <div width="100%" align="center">
2
- <a href="https://github.com/chiefmikey/mikey-pro">
3
- <b>Mikey Pro</b>
4
- </a>
5
- <h2>Style Guide</h2>
6
- <h4>Lint and Format Code (the way Mikey likes it)</h4>
7
-
8
- _A curated compilation of packages, plugins, style guides, custom configurations
9
- <br> and modified rules for consistently writing top shelf code_
10
-
11
- #### Compatibility
12
-
13
- <table>
14
- <thead>
15
- <tr>
16
- <th align="left">Languages</th>
17
- <th align="left">Frameworks</th>
18
- </tr>
19
- </thead>
20
- <tbody>
21
- <tr>
22
- <td valign="top">
23
- JavaScript
24
- <br>
25
- TypeScript
26
- <br>
27
- HTML
28
- <br>
29
- CSS
30
- <br>
31
- SCSS
32
- <br>
33
- LESS
34
- <br>
35
- Markdown
36
- <br>
37
- YAML
38
- <br>
39
- JSON
40
- <br>
41
- JSONC
42
- <br>
43
- JSON5
44
- </td>
45
- <td valign="top">
46
- React
47
- <br>
48
- Svelte
49
- <br>
50
- Vue
51
- <br>
52
- Jest
53
- <br>
54
- Cypress
55
- </td>
56
- </tr>
57
-
58
- </tbody>
59
- </table>
60
- </div>
61
-
62
- ## Requirements
63
-
64
- Install extensions:
65
- <a href="https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint">ESLint</a>
66
- |
67
- <a href="https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode">Prettier</a>
68
- |
69
- <a href="https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint">Stylelint</a>
70
-
71
- Additional support:
72
- <a href="https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck">ShellCheck</a>
73
-
74
- ## Usage
75
-
76
- ### Install
77
-
78
- ```shell
79
- npm i -D mikey-pro
80
- ```
81
-
82
- ### Configuration
83
-
84
- Add bundled configs to `package.json`
85
-
86
- ```json
87
- {
88
- "prettier": "@mikey-pro/prettier-config",
89
- "eslintConfig": {
90
- "extends": "@mikey-pro/eslint-config"
91
- },
92
- "stylelint": {
93
- "extends": "@mikey-pro/stylelint-config"
94
- }
95
- }
96
- ```
97
-
98
- ### Frameworks
99
-
100
- Each framework configuration extends the base `@mikey-pro/eslint-config`
101
-
102
- #### React
103
-
104
- ```shell
105
- npm i -D mikey-pro @mikey-pro/eslint-config-react
106
- ```
107
-
108
- ```json
109
- {
110
- "eslintConfig": {
111
- "extends": "@mikey-pro/eslint-config-react"
112
- }
113
- }
114
- ```
115
-
116
- #### Svelte
117
-
118
- ```shell
119
- npm i -D mikey-pro @mikey-pro/eslint-config-svelte
120
- ```
121
-
122
- ```json
123
- {
124
- "eslintConfig": {
125
- "extends": "@mikey-pro/eslint-config-svelte"
126
- }
127
- }
128
- ```
129
-
130
- <a href="https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode">Svelte
131
- Extension</a>
132
-
133
- #### Vue
134
-
135
- ```shell
136
- npm i -D mikey-pro @mikey-pro/eslint-config-vue
137
- ```
138
-
139
- ```json
140
- {
141
- "eslintConfig": {
142
- "extends": "@mikey-pro/eslint-config-vue"
143
- }
144
- }
145
- ```
146
-
147
- <a href="https://marketplace.visualstudio.com/items?itemName=Vue.volar">Vue
148
- Extension</a>