@antelopejs/tooling-configs 0.0.4 → 0.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.
package/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright (c) 2025-present - AntelopeJS Team
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
package/README.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @antelopejs/tooling-configs
2
2
 
3
+ <div align="center">
4
+ <a href="https://www.npmjs.com/package/@antelopejs/tooling-configs"><img alt="NPM version" src="https://img.shields.io/npm/v/@antelopejs/tooling-configs.svg?style=for-the-badge&labelColor=000000"></a>
5
+ <a href="./LICENSE"><img alt="License" src="https://img.shields.io/npm/l/@antelopejs/tooling-configs.svg?style=for-the-badge&labelColor=000000"></a>
6
+ <a href="https://discord.gg/sjK28QHrA7"><img src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000" alt="Discord"></a>
7
+ <a href="https://antelopejs.com"><img src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000" alt="Documentation"></a>
8
+ </div>
9
+
3
10
  Shared tooling presets for AntelopeJS repositories: [oxlint](https://oxc.rs) (including
4
11
  the vendored [anti-slop](https://github.com/dmmulroy/anti-slop) rules), [oxfmt](https://oxc.rs)
5
12
  and [Knip](https://knip.dev).
@@ -153,10 +160,10 @@ Extra ignores are **added** to the shared ones rather than replacing them, so a
153
160
  adopting oxfmt in stages can park a directory without losing the rest:
154
161
 
155
162
  ```ts
156
- export default antelopeFmtPreset({ ignorePatterns: ["nuxt-layer/**"] });
163
+ export default antelopeFmtPreset({ ignorePatterns: ["frontend-vue/**"] });
157
164
  ```
158
165
 
159
- In a Nuxt layer, pass the theme stylesheet to replace `prettier-plugin-tailwindcss`:
166
+ In a front end, pass the theme stylesheet to replace `prettier-plugin-tailwindcss`:
160
167
 
161
168
  ```ts
162
169
  export default antelopeFmtPreset({
@@ -172,12 +179,12 @@ that the preset does not (`noRestrictedImports` guards become `import/no-cycle`)
172
179
  in its own commit and record it in `.git-blame-ignore-revs`, which GitHub honours, so the
173
180
  pass does not bury the history.
174
181
 
175
- ## ESLint (Nuxt layers)
182
+ ## ESLint (front ends)
176
183
 
177
184
  oxlint does not lint `.vue` files yet, so the front end stays on ESLint:
178
185
 
179
186
  ```js
180
- // nuxt-layer/eslint.config.mjs
187
+ // frontend-vue/eslint.config.mjs
181
188
  import { antelopeNuxtConfig } from "@antelopejs/tooling-configs/eslint";
182
189
 
183
190
  export default antelopeNuxtConfig({ dirs: ["./playground"] });
@@ -202,10 +209,18 @@ import { antelopeKnipConfig } from "@antelopejs/tooling-configs/knip";
202
209
  export default antelopeKnipConfig();
203
210
  ```
204
211
 
205
- The defaults declare what Knip cannot infer for an AntelopeJS module: `src/index.ts` and
206
- the interface subpaths as public API, and `src/test/**/*.test.ts` as entry points, since
207
- `ajs module test` is not a runner Knip has a plugin for. Without them, Knip reports the
208
- whole test suite as dead code.
212
+ The defaults declare what Knip cannot infer for an AntelopeJS module: the interface
213
+ subpaths as public API, and `src/test/**` plus a root `antelope.test.ts` as entry points,
214
+ since `ajs module test` is not a runner Knip has a plugin for. Without them, Knip reports
215
+ the whole test suite as dead code.
216
+
217
+ `src/index.ts` is not among them on purpose: Knip already maps the `main`/`bin` of
218
+ package.json (`dist/index.js`) back onto `src/index.ts`, ahead of the `dist/**` ignore, so
219
+ repeating it only earns a "redundant pattern" hint.
220
+
221
+ The front end is left out of `project` rather than ignored, so a repository that wants
222
+ `frontend-vue/` analysed can add it under Knip's `workspaces` without the preset
223
+ overriding the choice.
209
224
 
210
225
  ## Vendored anti-slop
211
226
 
package/dist/knip.mjs CHANGED
@@ -1,22 +1,33 @@
1
1
  //#region src/knip.ts
2
+ /**
3
+ * `src/index.ts` is deliberately absent: Knip derives the module entry from
4
+ * package.json before any ignore applies, mapping `main`/`bin`
5
+ * (`dist/index.js`) back onto `src/index.{ts,...}`, so `dist/**` in
6
+ * {@link DEFAULT_IGNORE} does not hide it. Listing it here is reported as a
7
+ * redundant pattern instead.
8
+ *
9
+ * The front end is absent too: {@link DEFAULT_PROJECT} only reaches `src/`, so
10
+ * `frontend-vue/` is outside the analysis unless a repository opts it in
11
+ * through Knip's `workspaces`, which an ignore here would then override.
12
+ */
2
13
  const DEFAULT_ENTRY = [
3
14
  "src/interfaces/**/*.ts",
4
- "src/test/**/*.test.ts",
15
+ "src/test/**",
16
+ "antelope.test.ts",
5
17
  "scripts/**/*.{ts,mjs}"
6
18
  ];
7
19
  const DEFAULT_PROJECT = ["src/**/*.ts", "scripts/**/*.{ts,mjs}"];
8
20
  const DEFAULT_IGNORE = [
9
21
  "dist/**",
10
- "nuxt-layer/**",
11
22
  "playground/**",
12
23
  ".antelope/**"
13
24
  ];
14
25
  /**
15
- * `typecheck` is a script in the Nuxt layer's own manifest, outside the analysed
16
- * project, and every layer's CI runs it.
26
+ * `typecheck` is a script in the front end's own manifest, outside the analysed
27
+ * project, and every front end's CI runs it.
17
28
  *
18
29
  * The AntelopeJS CLIs are deliberately absent: a repository that invokes `ajs`
19
- * or `acms` declares the package providing it, so Knip resolves them and an
30
+ * or `ajs-dms` declares the package providing it, so Knip resolves them and an
20
31
  * ignore would only hide a missing dependency.
21
32
  */
22
33
  const DEFAULT_IGNORE_BINARIES = ["typecheck"];
@@ -25,7 +25,7 @@ interface AntelopeFmtOptions extends Partial<OxfmtOptions> {
25
25
  /**
26
26
  * Extra paths to leave alone. These are **added** to the shared ignores, not
27
27
  * substituted for them: a repository adopting oxfmt in stages needs to park
28
- * `nuxt-layer/**` for a while without also un-ignoring its own build output.
28
+ * `frontend-vue/**` for a while without also un-ignoring its own build output.
29
29
  */
30
30
  ignorePatterns?: string[];
31
31
  }
package/dist/oxc/fmt.mjs CHANGED
@@ -1,4 +1,4 @@
1
- import { n as IGNORE_PATTERNS, t as AGENT_IGNORE_PATTERNS } from "../shared-DYvliWWW.mjs";
1
+ import { n as IGNORE_PATTERNS, t as AGENT_IGNORE_PATTERNS } from "../shared-Ch-ZcMQb.mjs";
2
2
  import { defineConfig } from "oxfmt";
3
3
  //#region src/oxc/fmt.ts
4
4
  /**
@@ -53,15 +53,30 @@ interface AntelopePresetOptions {
53
53
  });
54
54
  /**
55
55
  * Import sorting through `eslint-plugin-perfectionist`, autofixed by
56
- * `oxlint --fix`. Repositories that still let Biome organize imports must
57
- * leave this off until they drop that assist, or the two tools fight.
56
+ * `oxlint --fix`.
57
+ *
58
+ * Off by default, because the sort moves value imports across side-effect
59
+ * imports and module evaluation order is load-bearing in an AntelopeJS
60
+ * module: `import "./components"` is what puts the decorated classes in the
61
+ * registry. Running it over the cms/dms repositories moved
62
+ * `import { CORE_SCHEMA_NAME } from ".../constants"` from before
63
+ * `import "./db"` to after `import "./routes"` -- in a file whose comment
64
+ * says the position is deliberate -- and broke the package at require time.
65
+ * Nothing in a typecheck or a build catches it.
66
+ *
67
+ * `sortSideEffects: false` is not enough: it keeps side-effect imports in
68
+ * place (verified across 1402 files, none moved) but lets everything else
69
+ * cross them. `partitionByNewLine`, which would fix that, is refused by
70
+ * perfectionist 5.11 -- it conflicts with both `newlinesBetween` and
71
+ * `newlinesInside`. Turn this back on when the rule can guarantee that no
72
+ * import crosses a side-effect import.
58
73
  *
59
74
  * The plugin is an optional peer dependency: it pulls ESLint and
60
- * typescript-eslint in with it, which a repository that turns this off has no
75
+ * typescript-eslint in with it, which a repository leaving this off has no
61
76
  * reason to install. Add `eslint-plugin-perfectionist` alongside this package
62
- * when leaving it on.
77
+ * when turning it on.
63
78
  *
64
- * @default true
79
+ * @default false
65
80
  */
66
81
  importSorting?: boolean;
67
82
  /**
package/dist/oxc/lint.mjs CHANGED
@@ -1,4 +1,4 @@
1
- import { n as IGNORE_PATTERNS, t as AGENT_IGNORE_PATTERNS } from "../shared-DYvliWWW.mjs";
1
+ import { n as IGNORE_PATTERNS, t as AGENT_IGNORE_PATTERNS } from "../shared-Ch-ZcMQb.mjs";
2
2
  import { defineConfig } from "oxlint";
3
3
  //#region src/oxc/lint.ts
4
4
  /**
@@ -229,7 +229,7 @@ function antelopePreset(options = {}) {
229
229
  options.typeAware === false ? null : typeAwarePreset(),
230
230
  antiSlopSeverity === "off" ? null : antiSlopPreset(antiSlopSeverity),
231
231
  complexitySeverity === "off" ? null : complexityPreset(complexityThresholds, complexitySeverity),
232
- options.importSorting === false ? null : importSortingPreset()
232
+ options.importSorting === true ? importSortingPreset() : null
233
233
  ].filter((config) => config !== null),
234
234
  rules: { "typescript/no-floating-promises": options.typeAware === false ? "off" : "error" }
235
235
  });
@@ -9,8 +9,8 @@ const IGNORE_PATTERNS = [
9
9
  "**/.nuxt/**",
10
10
  "**/.output/**",
11
11
  "**/output/**",
12
- "**/generated-layers.json",
13
- "**/i18n-registry.generated.ts"
12
+ "**/i18n-registry.generated.ts",
13
+ ".github/ISSUE_TEMPLATE/**"
14
14
  ];
15
15
  /** Agent tooling directories: assets we install, not source we own. */
16
16
  const AGENT_IGNORE_PATTERNS = [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@antelopejs/tooling-configs",
3
- "version": "0.0.4",
3
+ "version": "0.0.6",
4
4
  "description": "Shared tooling presets for AntelopeJS projects: oxlint (incl. vendored anti-slop) and Knip",
5
5
  "keywords": [
6
6
  "antelopejs",