@ntnyq/eslint-config 3.2.2 → 3.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.
package/README.md CHANGED
@@ -108,7 +108,7 @@ Check for detail in:
108
108
  ### Config interface
109
109
 
110
110
  ```ts
111
- export interface ConfigOptions {
111
+ export interface ConfigOptions extends ConfigOptionsInternal {
112
112
  ignores?: ConfigIgnoresOptions
113
113
 
114
114
  sort?: boolean | ConfigSortOptions
@@ -123,6 +123,8 @@ export interface ConfigOptions {
123
123
 
124
124
  javascript?: ConfigJavaScriptOptions
125
125
 
126
+ stylistic?: boolean | ConfigStylisticOptions
127
+
126
128
  typescript?: boolean | ConfigTypeScriptOptions
127
129
 
128
130
  unicorn?: boolean | ConfigUnicornOptions
@@ -131,21 +133,6 @@ export interface ConfigOptions {
131
133
 
132
134
  perfectionist?: boolean | ConfigPerfectionistOptions
133
135
 
134
- /**
135
- * @internal
136
- */
137
- unusedImports?: boolean | ConfigUnusedImportsOptions
138
-
139
- /**
140
- * @internal
141
- */
142
- antfu?: boolean | ConfigAntfuOptions
143
-
144
- /**
145
- * @internal
146
- */
147
- ntnyq?: boolean | ConfigNtnyqOptions
148
-
149
136
  comments?: boolean | ConfigCommentsOptions
150
137
 
151
138
  jsdoc?: boolean | ConfigJsdocOptions
@@ -165,9 +152,30 @@ export interface ConfigOptions {
165
152
  vue?: boolean | ConfigVueOptions
166
153
 
167
154
  test?: boolean | ConfigTestOptions
155
+
156
+ antfu?: boolean | ConfigAntfuOptions
157
+
158
+ githubAction?: boolean | ConfigGitHubActionOptions
168
159
  }
169
160
  ```
170
161
 
162
+ ## Versioning policy
163
+
164
+ This project follows [Semantic Versioning](https://semver.org/) for releases.
165
+
166
+ ### Changes considered as Breaking Changes
167
+
168
+ - Node.js version requirement changes
169
+ - Huge refactors that might break the config
170
+ - Plugins made major changes that might break the config
171
+ - Changes that might affect most of the codebases
172
+
173
+ ### Changes considered as Non-Breaking Changes
174
+
175
+ - Enable/disable rules and plugins (that might become stricter)
176
+ - Rules options changes
177
+ - Version bumps of dependencies
178
+
171
179
  ## Credits
172
180
 
173
181
  - [@sxzz/eslint-config](https://github.com/sxzz/eslint-config)