@storm-software/eslint-plugin-banner 0.0.2
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 +201 -0
- package/README.md +336 -0
- package/dist/configs/index.d.mts +6 -0
- package/dist/configs/index.mjs +5 -0
- package/dist/configs/recommended.d.mts +6 -0
- package/dist/configs/recommended.mjs +15 -0
- package/dist/helpers/create-rule.d.mts +15 -0
- package/dist/helpers/create-rule.mjs +48 -0
- package/dist/helpers/get-banner.d.mts +19 -0
- package/dist/helpers/get-banner.mjs +51 -0
- package/dist/index.d.mts +35 -0
- package/dist/index.mjs +29 -0
- package/dist/package.mjs +4 -0
- package/dist/plugin.d.mts +15 -0
- package/dist/plugin.mjs +12 -0
- package/dist/rules/banner.d.mts +20 -0
- package/dist/rules/banner.mjs +253 -0
- package/docs/rules/banner.md +72 -0
- package/package.json +80 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
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
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,336 @@
|
|
|
1
|
+
<!-- START header -->
|
|
2
|
+
<!-- prettier-ignore-start -->
|
|
3
|
+
<!-- markdownlint-disable -->
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
<div align="center">
|
|
7
|
+
<picture>
|
|
8
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://public.storm-cdn.com/storm-software/banner-1280x640-dark.gif">
|
|
9
|
+
<source media="(prefers-color-scheme: light)" srcset="https://public.storm-cdn.com/storm-software/banner-1280x640-light.gif">
|
|
10
|
+
<img src="https://public.storm-cdn.com/storm-software/banner-1280x640-dark.gif" width="100%" alt="Storm Software" />
|
|
11
|
+
</picture>
|
|
12
|
+
</div>
|
|
13
|
+
<br />
|
|
14
|
+
|
|
15
|
+
<div align="center">
|
|
16
|
+
<b>
|
|
17
|
+
<a href="https://stormsoftware.com" target="_blank">Website</a> •
|
|
18
|
+
<a href="https://github.com/storm-software/storm-ops" target="_blank">GitHub</a> •
|
|
19
|
+
<a href="https://discord.gg/MQ6YVzakM5">Discord</a> • <a href="https://stormstack.github.io/stormstack/" target="_blank">Docs</a> • <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> •
|
|
20
|
+
<a href="https://github.com/storm-software/storm-ops/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a>
|
|
21
|
+
</b>
|
|
22
|
+
</div>
|
|
23
|
+
|
|
24
|
+
<br />
|
|
25
|
+
This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.
|
|
26
|
+
<br />
|
|
27
|
+
|
|
28
|
+
<h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
|
|
29
|
+
|
|
30
|
+
[](https://prettier.io/) [](http://nx.dev/) [](https://nextjs.org/) [](http://commitizen.github.io/cz-cli/)  [](https://fumadocs.vercel.app/) 
|
|
31
|
+
|
|
32
|
+
<!-- prettier-ignore-start -->
|
|
33
|
+
<!-- markdownlint-disable -->
|
|
34
|
+
|
|
35
|
+
> [!IMPORTANT]
|
|
36
|
+
> This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be available through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
|
|
37
|
+
|
|
38
|
+
<!-- markdownlint-restore -->
|
|
39
|
+
<!-- prettier-ignore-end -->
|
|
40
|
+
|
|
41
|
+
<div align="center">
|
|
42
|
+
<b>Be sure to ⭐ this <a href="https://github.com/storm-software/storm-ops" target="_blank">repository on GitHub</a> so you can keep up to date on any daily progress!</b>
|
|
43
|
+
</div>
|
|
44
|
+
|
|
45
|
+
<br />
|
|
46
|
+
|
|
47
|
+
<!-- START doctoc -->
|
|
48
|
+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
|
|
49
|
+
|
|
50
|
+
## Table of Contents
|
|
51
|
+
|
|
52
|
+
- [Storm Software - Banner Plugin for ESLint](#storm-software---banner-plugin-for-eslint)
|
|
53
|
+
- [Installing](#installing)
|
|
54
|
+
- [Rules](#rules)
|
|
55
|
+
- [Options](#options)
|
|
56
|
+
- [Configurations](#configurations)
|
|
57
|
+
- [Building](#building)
|
|
58
|
+
- [Running unit tests](#running-unit-tests)
|
|
59
|
+
- [Storm Workspaces](#storm-workspaces)
|
|
60
|
+
- [Roadmap](#roadmap)
|
|
61
|
+
- [Support](#support)
|
|
62
|
+
- [License](#license)
|
|
63
|
+
- [Changelog](#changelog)
|
|
64
|
+
- [Contributing](#contributing)
|
|
65
|
+
- [Contributors](#contributors)
|
|
66
|
+
|
|
67
|
+
<!-- END doctoc -->
|
|
68
|
+
|
|
69
|
+
<br />
|
|
70
|
+
|
|
71
|
+
<!-- markdownlint-restore -->
|
|
72
|
+
<!-- prettier-ignore-end -->
|
|
73
|
+
|
|
74
|
+
<!-- END header -->
|
|
75
|
+
|
|
76
|
+
# Storm Software - Banner Plugin for ESLint
|
|
77
|
+
|
|
78
|
+
This package provides an ESLint plugin that enforces the presence of a standardized banner comment at the top of source files. The banner includes important information about the project, such as licensing, contact information, and links to documentation.
|
|
79
|
+
|
|
80
|
+
## Installing
|
|
81
|
+
|
|
82
|
+
Using [pnpm](http://pnpm.io):
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
pnpm add -D @storm-software/eslint-plugin-banner
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
<details>
|
|
89
|
+
<summary>Using npm</summary>
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
npm install -D @storm-software/eslint-plugin-banner
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
</details>
|
|
96
|
+
|
|
97
|
+
<details>
|
|
98
|
+
<summary>Using yarn</summary>
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
yarn add -D @storm-software/eslint-plugin-banner
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
</details>
|
|
105
|
+
|
|
106
|
+
## Rules
|
|
107
|
+
|
|
108
|
+
<!-- begin auto-generated rules list -->
|
|
109
|
+
|
|
110
|
+
💼 Configurations enabled in.\
|
|
111
|
+
🌟 Set in the `recommended` configuration.\
|
|
112
|
+
🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
|
|
113
|
+
|
|
114
|
+
| Name | Description | 💼 | 🔧 |
|
|
115
|
+
| :----------------------------- | :---------------------------------------------------------------------------------- | :-- | :-- |
|
|
116
|
+
| [banner](docs/rules/banner.md) | Ensures the file has a organization specific banner at the top of source code files | 🌟 | 🔧 |
|
|
117
|
+
|
|
118
|
+
<!-- end auto-generated rules list -->
|
|
119
|
+
|
|
120
|
+
## Options
|
|
121
|
+
|
|
122
|
+
The following options are available for this plugin:
|
|
123
|
+
|
|
124
|
+
<!-- begin auto-generated rule options list -->
|
|
125
|
+
|
|
126
|
+
| Name | Description | Type | Choices | Required |
|
|
127
|
+
| :------------- | :-------------------------------------------------------------------------- | :----- | :---------------- | :------- |
|
|
128
|
+
| `commentStyle` | The comment token to use for the banner. Defaults to block ('/_<banner>_/') | String | | |
|
|
129
|
+
| `docs` | The documentation URL to include in the banner. | String | | |
|
|
130
|
+
| `homepage` | The homepage URL to include in the banner. | String | | |
|
|
131
|
+
| `license` | The project license to include in the banner. | String | | |
|
|
132
|
+
| `licensing` | The licensing URL to include in the banner. | String | | |
|
|
133
|
+
| `lineEndings` | The type of line endings to use. Defaults to the system default | String | `unix`, `windows` | |
|
|
134
|
+
| `name` | The name of the repository to use when reading the banner from a file. | String | | Yes |
|
|
135
|
+
| `newlines` | The number of newlines to use after the banner. Defaults to 1 | Number | | |
|
|
136
|
+
| `organization` | The organization to include in the banner. | String | | |
|
|
137
|
+
| `repository` | The repository URL to include in the banner. | String | | |
|
|
138
|
+
|
|
139
|
+
<!-- end auto-generated rule options list -->
|
|
140
|
+
|
|
141
|
+
## Configurations
|
|
142
|
+
|
|
143
|
+
The following configurations are available for this plugin:
|
|
144
|
+
|
|
145
|
+
<!-- begin auto-generated configs list -->
|
|
146
|
+
|
|
147
|
+
| | Name |
|
|
148
|
+
| :-- | :------------ |
|
|
149
|
+
| 🌟 | `recommended` |
|
|
150
|
+
|
|
151
|
+
<!-- end auto-generated configs list -->
|
|
152
|
+
|
|
153
|
+
## Building
|
|
154
|
+
|
|
155
|
+
Run `nx build eslint-plugin-banner` to build the library.
|
|
156
|
+
|
|
157
|
+
## Running unit tests
|
|
158
|
+
|
|
159
|
+
Run `nx test eslint-plugin-banner` to execute the unit tests via [Jest](https://jestjs.io).
|
|
160
|
+
|
|
161
|
+
<!-- START footer -->
|
|
162
|
+
<!-- prettier-ignore-start -->
|
|
163
|
+
<!-- markdownlint-disable -->
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
## Storm Workspaces
|
|
167
|
+
|
|
168
|
+
Storm workspaces are built using
|
|
169
|
+
<a href="https://nx.dev/" target="_blank">Nx</a>, a set of extensible dev tools
|
|
170
|
+
for monorepos, which helps you develop like Google, Facebook, and Microsoft.
|
|
171
|
+
Building on top of Nx, the Open System provides a set of tools and patterns that
|
|
172
|
+
help you scale your monorepo to many teams while keeping the codebase
|
|
173
|
+
maintainable.
|
|
174
|
+
|
|
175
|
+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
176
|
+
<br />
|
|
177
|
+
|
|
178
|
+
## Roadmap
|
|
179
|
+
|
|
180
|
+
See the [open issues](https://github.com/storm-software/storm-ops/issues) for a
|
|
181
|
+
list of proposed features (and known issues).
|
|
182
|
+
|
|
183
|
+
- [Top Feature Requests](https://github.com/storm-software/storm-ops/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
|
|
184
|
+
(Add your votes using the 👍 reaction)
|
|
185
|
+
- [Top Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc)
|
|
186
|
+
(Add your votes using the 👍 reaction)
|
|
187
|
+
- [Newest Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
|
|
188
|
+
|
|
189
|
+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
190
|
+
<br />
|
|
191
|
+
|
|
192
|
+
## Support
|
|
193
|
+
|
|
194
|
+
Reach out to the maintainer at one of the following places:
|
|
195
|
+
|
|
196
|
+
- [Contact](https://stormsoftware.com/contact)
|
|
197
|
+
- [GitHub discussions](https://github.com/storm-software/storm-ops/discussions)
|
|
198
|
+
- <support@stormsoftware.com>
|
|
199
|
+
|
|
200
|
+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
201
|
+
<br />
|
|
202
|
+
|
|
203
|
+
## License
|
|
204
|
+
|
|
205
|
+
This project is licensed under the **Apache License 2.0**. Feel free to edit and
|
|
206
|
+
distribute this template as you like.
|
|
207
|
+
|
|
208
|
+
See [LICENSE](LICENSE) for more information.
|
|
209
|
+
|
|
210
|
+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
211
|
+
<br />
|
|
212
|
+
|
|
213
|
+
## Changelog
|
|
214
|
+
|
|
215
|
+
This project adheres to
|
|
216
|
+
[Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every release, along
|
|
217
|
+
with the migration instructions, is documented in the [CHANGELOG](CHANGELOG.md)
|
|
218
|
+
file
|
|
219
|
+
|
|
220
|
+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
221
|
+
<br />
|
|
222
|
+
|
|
223
|
+
## Contributing
|
|
224
|
+
|
|
225
|
+
First off, thanks for taking the time to contribute! Contributions are what
|
|
226
|
+
makes the open-source community such an amazing place to learn, inspire, and
|
|
227
|
+
create. Any contributions you make will benefit everybody else and are **greatly
|
|
228
|
+
appreciated**.
|
|
229
|
+
|
|
230
|
+
Please try to create bug reports that are:
|
|
231
|
+
|
|
232
|
+
- _Reproducible._ Include steps to reproduce the problem.
|
|
233
|
+
- _Specific._ Include as much detail as possible: which version, what
|
|
234
|
+
environment, etc.
|
|
235
|
+
- _Unique._ Do not duplicate existing opened issues.
|
|
236
|
+
- _Scoped to a Single Bug._ One bug per report.
|
|
237
|
+
|
|
238
|
+
Please adhere to this project's [code of conduct](.github/CODE_OF_CONDUCT.md).
|
|
239
|
+
|
|
240
|
+
You can use
|
|
241
|
+
[markdownlint-cli](https://github.com/storm-software/storm-ops/markdownlint-cli)
|
|
242
|
+
to check for common markdown style inconsistency.
|
|
243
|
+
|
|
244
|
+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
245
|
+
<br />
|
|
246
|
+
|
|
247
|
+
## Contributors
|
|
248
|
+
|
|
249
|
+
Thanks goes to these wonderful people
|
|
250
|
+
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
|
|
251
|
+
|
|
252
|
+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
253
|
+
|
|
254
|
+
<table>
|
|
255
|
+
<tbody>
|
|
256
|
+
<tr>
|
|
257
|
+
<td align="center" valign="top" width="14.28%"><a href="http://www.sullypat.com/"><img src="https://avatars.githubusercontent.com/u/99053093?v=4?s=100" width="100px;" alt="Patrick Sullivan"/><br /><sub><b>Patrick Sullivan</b></sub></a><br /><a href="#design-sullivanpj" title="Design">🎨</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Code">💻</a> <a href="#tool-sullivanpj" title="Tools">🔧</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Documentation">📖</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Tests">⚠️</a></td>
|
|
258
|
+
<td align="center" valign="top" width="14.28%"><a href="https://tylerbenning.com/"><img src="https://avatars.githubusercontent.com/u/7265547?v=4?s=100" width="100px;" alt="Tyler Benning"/><br /><sub><b>Tyler Benning</b></sub></a><br /><a href="#design-tbenning" title="Design">🎨</a></td>
|
|
259
|
+
<td align="center" valign="top" width="14.28%"><a href="http://stormsoftware.com"><img src="https://avatars.githubusercontent.com/u/149802440?v=4?s=100" width="100px;" alt="Stormie"/><br /><sub><b>Stormie</b></sub></a><br /><a href="#maintenance-stormie-bot" title="Maintenance">🚧</a></td>
|
|
260
|
+
</tr>
|
|
261
|
+
</tbody>
|
|
262
|
+
<tfoot>
|
|
263
|
+
<tr>
|
|
264
|
+
<td align="center" size="13px" colspan="7">
|
|
265
|
+
<img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg" alt="All Contributors">
|
|
266
|
+
<a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
|
|
267
|
+
</img>
|
|
268
|
+
</td>
|
|
269
|
+
</tr>
|
|
270
|
+
</tfoot>
|
|
271
|
+
</table>
|
|
272
|
+
|
|
273
|
+
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
274
|
+
|
|
275
|
+
This project follows the
|
|
276
|
+
[all-contributors](https://github.com/all-contributors/all-contributors)
|
|
277
|
+
specification. Contributions of any kind welcome!
|
|
278
|
+
|
|
279
|
+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
280
|
+
<br />
|
|
281
|
+
|
|
282
|
+
<hr />
|
|
283
|
+
<br />
|
|
284
|
+
|
|
285
|
+
<div align="center">
|
|
286
|
+
<picture>
|
|
287
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://public.storm-cdn.com/storm-software/banner-1280x320-dark.webp">
|
|
288
|
+
<source media="(prefers-color-scheme: light)" srcset="https://public.storm-cdn.com/storm-software/banner-1280x320-light.webp">
|
|
289
|
+
<img src="https://public.storm-cdn.com/storm-software/banner-1280x320-dark.webp" width="100%" alt="Storm Software" />
|
|
290
|
+
</picture>
|
|
291
|
+
</div>
|
|
292
|
+
<br />
|
|
293
|
+
|
|
294
|
+
<div align="center">
|
|
295
|
+
<a href="https://stormsoftware.com" target="_blank">Website</a> • <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> • <a href="https://linkedin.com/in/patrick-sullivan-865526b0" target="_blank">LinkedIn</a> • <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a> • <a href="https://github.com/storm-software" target="_blank">GitHub</a> • <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
|
|
296
|
+
</div>
|
|
297
|
+
|
|
298
|
+
<div align="center">
|
|
299
|
+
<b>Fingerprint:</b> F47F 1853 BCAD DE9B 42C8 6316 9FDE EC95 47FE D106
|
|
300
|
+
</div>
|
|
301
|
+
<br />
|
|
302
|
+
|
|
303
|
+
Storm Software is an open source software development organization and creator
|
|
304
|
+
of Acidic, StormStack and StormCloud.
|
|
305
|
+
|
|
306
|
+
Our mission is to make software development more accessible. Our ideal future is
|
|
307
|
+
one where anyone can create software without years of prior development
|
|
308
|
+
experience serving as a barrier to entry. We hope to achieve this via LLMs,
|
|
309
|
+
Generative AI, and intuitive, high-level data modeling/programming languages.
|
|
310
|
+
|
|
311
|
+
Join us on [Discord](https://discord.gg/MQ6YVzakM5) to chat with the team,
|
|
312
|
+
receive release notifications, ask questions, and get involved.
|
|
313
|
+
|
|
314
|
+
If this sounds interesting, and you would like to help us in creating the next
|
|
315
|
+
generation of development tools, please reach out on our
|
|
316
|
+
[website](https://stormsoftware.com/contact) or join our
|
|
317
|
+
[Slack](https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA)
|
|
318
|
+
channel!
|
|
319
|
+
|
|
320
|
+
<br />
|
|
321
|
+
|
|
322
|
+
<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/icon-fill.png" alt="Storm Software" width="200px"/></a></div>
|
|
323
|
+
<br />
|
|
324
|
+
<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://public.storm-cdn.com/visit-us-text.svg" alt="Visit us at stormsoftware.com" height="90px"/></a></div>
|
|
325
|
+
|
|
326
|
+
<br />
|
|
327
|
+
|
|
328
|
+
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
|
|
329
|
+
<br />
|
|
330
|
+
<br />
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<!-- markdownlint-restore -->
|
|
334
|
+
<!-- prettier-ignore-end -->
|
|
335
|
+
|
|
336
|
+
<!-- END footer -->
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { plugin } from "../plugin.mjs";
|
|
2
|
+
import { GLOB_EXCLUDE, GLOB_SRC } from "@storm-software/package-constants";
|
|
3
|
+
//#region src/configs/recommended.ts
|
|
4
|
+
const config = {
|
|
5
|
+
files: [GLOB_SRC],
|
|
6
|
+
ignores: GLOB_EXCLUDE,
|
|
7
|
+
name: "storm-banner/recommended",
|
|
8
|
+
plugins: { "storm-banner": plugin },
|
|
9
|
+
rules: { "storm-banner/banner": ["error", {
|
|
10
|
+
commentType: "block",
|
|
11
|
+
numNewlines: 2
|
|
12
|
+
}] }
|
|
13
|
+
};
|
|
14
|
+
//#endregion
|
|
15
|
+
export { config as default };
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { Rule } from "eslint";
|
|
2
|
+
import { RuleWithMetaAndName } from "@typescript-eslint/utils/eslint-utils";
|
|
3
|
+
|
|
4
|
+
//#region src/helpers/create-rule.d.ts
|
|
5
|
+
type RuleModule<T extends readonly unknown[]> = Rule.RuleModule & {
|
|
6
|
+
defaultOptions: T;
|
|
7
|
+
};
|
|
8
|
+
declare const createRule: <TOptions extends readonly unknown[], TMessageIds extends string>({
|
|
9
|
+
name,
|
|
10
|
+
meta,
|
|
11
|
+
...rule
|
|
12
|
+
}: Readonly<RuleWithMetaAndName<TOptions, TMessageIds>>) => RuleModule<TOptions>;
|
|
13
|
+
declare function warnOnce(message: string): void;
|
|
14
|
+
//#endregion
|
|
15
|
+
export { RuleModule, createRule, warnOnce };
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import defu from "defu";
|
|
2
|
+
//#region src/helpers/create-rule.ts
|
|
3
|
+
/**
|
|
4
|
+
* Creates reusable function to create rules with default options and docs URLs.
|
|
5
|
+
*
|
|
6
|
+
* @param urlCreator - Creates a documentation URL for a given rule name.
|
|
7
|
+
* @returns Function to create a rule with the docs URL format.
|
|
8
|
+
*/
|
|
9
|
+
function RuleCreator(urlCreator) {
|
|
10
|
+
return function createNamedRule({ name, meta, ...rule }) {
|
|
11
|
+
return createRuleInfo({
|
|
12
|
+
meta: {
|
|
13
|
+
...meta,
|
|
14
|
+
docs: {
|
|
15
|
+
...meta.docs,
|
|
16
|
+
url: urlCreator(name)
|
|
17
|
+
}
|
|
18
|
+
},
|
|
19
|
+
...rule
|
|
20
|
+
});
|
|
21
|
+
};
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Creates a well-typed TSESLint custom ESLint rule without a docs URL.
|
|
25
|
+
*
|
|
26
|
+
* @returns Well-typed TSESLint custom ESLint rule.
|
|
27
|
+
* @remarks It is generally better to provide a docs URL function to RuleCreator.
|
|
28
|
+
*/
|
|
29
|
+
function createRuleInfo({ create, defaultOptions, meta }) {
|
|
30
|
+
return {
|
|
31
|
+
create: ((context) => {
|
|
32
|
+
return create(context, context.options.map((options, index) => {
|
|
33
|
+
return defu(defaultOptions?.[index] ?? {}, options);
|
|
34
|
+
}));
|
|
35
|
+
}),
|
|
36
|
+
defaultOptions: defaultOptions ?? {},
|
|
37
|
+
meta
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
const createRule = RuleCreator((ruleName) => `https://docs.stormsoftware.com/projects/shell-shock/eslint/rules/${ruleName}.md`);
|
|
41
|
+
const warned = /* @__PURE__ */ new Set();
|
|
42
|
+
function warnOnce(message) {
|
|
43
|
+
if (warned.has(message)) return;
|
|
44
|
+
warned.add(message);
|
|
45
|
+
console.warn(message);
|
|
46
|
+
}
|
|
47
|
+
//#endregion
|
|
48
|
+
export { createRule, warnOnce };
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
//#region src/helpers/get-banner.d.ts
|
|
2
|
+
interface BannerOptions {
|
|
3
|
+
name: string;
|
|
4
|
+
license?: string;
|
|
5
|
+
organization?: string;
|
|
6
|
+
licensing?: string;
|
|
7
|
+
repository?: string;
|
|
8
|
+
docs?: string;
|
|
9
|
+
homepage?: string;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Get a banner header to display at the top of a file
|
|
13
|
+
*
|
|
14
|
+
* @param options - The options for generating the banner header
|
|
15
|
+
* @returns The banner header
|
|
16
|
+
*/
|
|
17
|
+
declare function getBanner(options: BannerOptions): string;
|
|
18
|
+
//#endregion
|
|
19
|
+
export { BannerOptions, getBanner };
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
import { ACRONYMS_LIST } from "@storm-software/package-constants/acronyms";
|
|
2
|
+
//#region src/helpers/get-banner.ts
|
|
3
|
+
/**
|
|
4
|
+
* Get a banner header to display at the top of a file
|
|
5
|
+
*
|
|
6
|
+
* @param options - The options for generating the banner header
|
|
7
|
+
* @returns The banner header
|
|
8
|
+
*/
|
|
9
|
+
function getBanner(options) {
|
|
10
|
+
const { name } = options;
|
|
11
|
+
let padding = " ";
|
|
12
|
+
for (let i = 0; i < name.length + 2 && padding.length > 4; i++) padding = padding.slice(0, -1);
|
|
13
|
+
let titleName = name;
|
|
14
|
+
if (titleName) {
|
|
15
|
+
if (titleName?.startsWith("@")) titleName = titleName.slice(1);
|
|
16
|
+
titleName = (titleName.charAt(0).toUpperCase() + titleName.slice(1)).split("-").filter((word) => word && word.length > 0).map((word) => {
|
|
17
|
+
if (ACRONYMS_LIST.includes(word.toUpperCase())) return word.toUpperCase();
|
|
18
|
+
return word.charAt(0).toUpperCase() + word.slice(1);
|
|
19
|
+
}).join(" ");
|
|
20
|
+
}
|
|
21
|
+
const license = (options.license || "Apache-2.0").split(" ").filter((word) => word && word.toLowerCase() !== "license").join(" ");
|
|
22
|
+
const organization = options.organization || "storm-software";
|
|
23
|
+
const licensing = options.licensing?.replace(/\/$/, "") || "https://stormsoftware.com/licenses";
|
|
24
|
+
const homepage = options.homepage || "https://stormsoftware.com";
|
|
25
|
+
const repository = options.repository || `https://github.com/${organization}${name ? `/${name}` : ""}`;
|
|
26
|
+
const docs = options.docs || `https://docs.stormsoftware.com${name ? `/projects/${name}` : ""}`;
|
|
27
|
+
const formattedOrganization = (organization.charAt(0).toUpperCase() + organization.slice(1)).split("-").filter((word) => word && word.length > 0).map((word) => {
|
|
28
|
+
if (ACRONYMS_LIST.includes(word.toUpperCase())) return word.toUpperCase();
|
|
29
|
+
return word.charAt(0).toUpperCase() + word.slice(1);
|
|
30
|
+
}).join(" ");
|
|
31
|
+
const contactHomepage = homepage.endsWith("/") ? homepage.slice(0, -1) : homepage;
|
|
32
|
+
return ` -------------------------------------------------------------------
|
|
33
|
+
|
|
34
|
+
${padding}🗲 ${formattedOrganization} ${titleName ? `- ${titleName}` : ""}
|
|
35
|
+
|
|
36
|
+
This code was released as part of ${titleName ? `the ${titleName}` : `a ${formattedOrganization}`} project. ${titleName ? titleName : "The project"}
|
|
37
|
+
is maintained by ${formattedOrganization} under the ${license} license, and is
|
|
38
|
+
free for commercial and private use. For more information, please visit
|
|
39
|
+
our licensing page at ${licensing}/${name ? `projects/${name}` : ""}.
|
|
40
|
+
|
|
41
|
+
Website: ${homepage}
|
|
42
|
+
Repository: ${repository}
|
|
43
|
+
Documentation: ${docs}
|
|
44
|
+
Contact: ${contactHomepage}/contact
|
|
45
|
+
|
|
46
|
+
SPDX-License-Identifier: ${license}
|
|
47
|
+
|
|
48
|
+
------------------------------------------------------------------- `;
|
|
49
|
+
}
|
|
50
|
+
//#endregion
|
|
51
|
+
export { getBanner };
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { configs } from "./configs/index.mjs";
|
|
2
|
+
import { RuleModule } from "./helpers/create-rule.mjs";
|
|
3
|
+
import { Options } from "./rules/banner.mjs";
|
|
4
|
+
import { plugin } from "./plugin.mjs";
|
|
5
|
+
import { ESLint, Linter } from "eslint";
|
|
6
|
+
|
|
7
|
+
//#region src/index.d.ts
|
|
8
|
+
/**
|
|
9
|
+
* ESLint plugin for Storm Software to enforce a consistent banner header across all source files in a project.
|
|
10
|
+
*
|
|
11
|
+
* @packageDocumentation
|
|
12
|
+
* This plugin provides a rule to ensure that all source files contain a standardized banner header with metadata such as license information, organization name, and other relevant details. The banner header helps maintain consistency and provides important information about the file's ownership and licensing.
|
|
13
|
+
*
|
|
14
|
+
* The plugin includes a recommended configuration that can be extended in your ESLint configuration file to easily apply the banner rule across your project.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```json
|
|
18
|
+
* {
|
|
19
|
+
* "extends": ["plugin:storm-banner/recommended"]
|
|
20
|
+
* }
|
|
21
|
+
* ```
|
|
22
|
+
*
|
|
23
|
+
* This will apply the banner rule with the recommended settings, which can be customized further by providing options to the rule in your ESLint configuration.
|
|
24
|
+
*
|
|
25
|
+
* @see [Storm Software](https://stormsoftware.com) for more information about our projects and licensing.
|
|
26
|
+
*/
|
|
27
|
+
declare const eslintPlugin: ESLint.Plugin;
|
|
28
|
+
declare const rules: {
|
|
29
|
+
banner: RuleModule<Options>;
|
|
30
|
+
};
|
|
31
|
+
type RuleDefinitions = (typeof plugin)["rules"];
|
|
32
|
+
type RuleOptions = { [K in keyof RuleDefinitions]: RuleDefinitions[K]["defaultOptions"] };
|
|
33
|
+
type Rules = { [K in keyof RuleOptions]: Linter.RuleEntry<RuleOptions[K]> };
|
|
34
|
+
//#endregion
|
|
35
|
+
export { RuleOptions, Rules, configs, eslintPlugin as default, rules };
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { plugin } from "./plugin.mjs";
|
|
2
|
+
import { configs } from "./configs/index.mjs";
|
|
3
|
+
//#region src/index.ts
|
|
4
|
+
/**
|
|
5
|
+
* ESLint plugin for Storm Software to enforce a consistent banner header across all source files in a project.
|
|
6
|
+
*
|
|
7
|
+
* @packageDocumentation
|
|
8
|
+
* This plugin provides a rule to ensure that all source files contain a standardized banner header with metadata such as license information, organization name, and other relevant details. The banner header helps maintain consistency and provides important information about the file's ownership and licensing.
|
|
9
|
+
*
|
|
10
|
+
* The plugin includes a recommended configuration that can be extended in your ESLint configuration file to easily apply the banner rule across your project.
|
|
11
|
+
*
|
|
12
|
+
* @example
|
|
13
|
+
* ```json
|
|
14
|
+
* {
|
|
15
|
+
* "extends": ["plugin:storm-banner/recommended"]
|
|
16
|
+
* }
|
|
17
|
+
* ```
|
|
18
|
+
*
|
|
19
|
+
* This will apply the banner rule with the recommended settings, which can be customized further by providing options to the rule in your ESLint configuration.
|
|
20
|
+
*
|
|
21
|
+
* @see [Storm Software](https://stormsoftware.com) for more information about our projects and licensing.
|
|
22
|
+
*/
|
|
23
|
+
const eslintPlugin = {
|
|
24
|
+
...plugin,
|
|
25
|
+
configs
|
|
26
|
+
};
|
|
27
|
+
const rules = plugin.rules;
|
|
28
|
+
//#endregion
|
|
29
|
+
export { configs, eslintPlugin as default, rules };
|
package/dist/package.mjs
ADDED
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { RuleModule } from "./helpers/create-rule.mjs";
|
|
2
|
+
import { Options } from "./rules/banner.mjs";
|
|
3
|
+
|
|
4
|
+
//#region src/plugin.d.ts
|
|
5
|
+
declare const plugin: {
|
|
6
|
+
meta: {
|
|
7
|
+
name: string;
|
|
8
|
+
version: string;
|
|
9
|
+
};
|
|
10
|
+
rules: {
|
|
11
|
+
banner: RuleModule<Options>;
|
|
12
|
+
};
|
|
13
|
+
};
|
|
14
|
+
//#endregion
|
|
15
|
+
export { plugin };
|
package/dist/plugin.mjs
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { version } from "./package.mjs";
|
|
2
|
+
import banner_default from "./rules/banner.mjs";
|
|
3
|
+
//#region src/plugin.ts
|
|
4
|
+
const plugin = {
|
|
5
|
+
meta: {
|
|
6
|
+
name: "storm-banner",
|
|
7
|
+
version
|
|
8
|
+
},
|
|
9
|
+
rules: { banner: banner_default }
|
|
10
|
+
};
|
|
11
|
+
//#endregion
|
|
12
|
+
export { plugin };
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { RuleModule } from "../helpers/create-rule.mjs";
|
|
2
|
+
|
|
3
|
+
//#region src/rules/banner.d.ts
|
|
4
|
+
declare const RULE_NAME = "banner";
|
|
5
|
+
type MessageIds = "missingBanner" | "incorrectComment" | "incorrectBanner" | "noNewlineAfterBanner";
|
|
6
|
+
type Options = [{
|
|
7
|
+
name: string;
|
|
8
|
+
license?: string;
|
|
9
|
+
organization?: string;
|
|
10
|
+
licensing?: string;
|
|
11
|
+
repository?: string;
|
|
12
|
+
docs?: string;
|
|
13
|
+
homepage?: string;
|
|
14
|
+
commentStyle?: "block" | "line" | string;
|
|
15
|
+
newlines?: number;
|
|
16
|
+
lineEndings?: "unix" | "windows";
|
|
17
|
+
}];
|
|
18
|
+
declare const _default: RuleModule<Options>;
|
|
19
|
+
//#endregion
|
|
20
|
+
export { MessageIds, Options, RULE_NAME, _default as default };
|
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
import { createRule } from "../helpers/create-rule.mjs";
|
|
2
|
+
import { getBanner } from "../helpers/get-banner.mjs";
|
|
3
|
+
import { EOL } from "node:os";
|
|
4
|
+
//#region src/rules/banner.ts
|
|
5
|
+
const RULE_NAME = "banner";
|
|
6
|
+
function match(actual, expected) {
|
|
7
|
+
if (expected instanceof RegExp) return expected.test(actual);
|
|
8
|
+
else return expected === actual;
|
|
9
|
+
}
|
|
10
|
+
function excludeShebangs(comments) {
|
|
11
|
+
return comments.filter((comment) => {
|
|
12
|
+
return comment.type !== "Shebang";
|
|
13
|
+
});
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Get the leading comments for a node, excluding shebangs, and return either the first block comment or the first set of line comments that are only separated by a single newline.
|
|
17
|
+
*
|
|
18
|
+
* @param context - The ESLint rule context
|
|
19
|
+
* @param node - The AST node to get the leading comments for
|
|
20
|
+
* @returns An array of comment nodes that are either the first block comment or the first set of line comments that are only separated by a single newline
|
|
21
|
+
*/
|
|
22
|
+
function getLeadingComments(context, node) {
|
|
23
|
+
const firstBodyNode = Array.isArray(node.body) && node.body.length ? node.body[0] : node;
|
|
24
|
+
const all = excludeShebangs(context.getSourceCode().getAllComments(firstBodyNode));
|
|
25
|
+
if (!all.length) return [];
|
|
26
|
+
if (all[0] && all[0].type.toLowerCase() === "block") return [all[0]];
|
|
27
|
+
let i = 1;
|
|
28
|
+
for (i = 1; i < all.length; ++i) {
|
|
29
|
+
const prev = all[i - 1];
|
|
30
|
+
const current = all[i];
|
|
31
|
+
if (!prev || !current) break;
|
|
32
|
+
if (!context.getSourceCode().getText().slice(prev.range[1], current.range[0]).match(/^(\r\n|\r|\n)$/)) break;
|
|
33
|
+
}
|
|
34
|
+
return all.slice(0, i);
|
|
35
|
+
}
|
|
36
|
+
function genCommentBody(commentStyle, textArray, eol, newlines) {
|
|
37
|
+
const eols = eol.repeat(newlines);
|
|
38
|
+
if (commentStyle === "block") return "/*" + textArray.join(eol) + "*/" + eols;
|
|
39
|
+
else return "//" + textArray.join(eol + "//") + eols;
|
|
40
|
+
}
|
|
41
|
+
function genCommentsRange(context, comments, eol) {
|
|
42
|
+
if (!comments[0]) return [0, 0];
|
|
43
|
+
const start = comments[0].range[0];
|
|
44
|
+
let end = comments.slice(-1)[0]?.range[1] ?? start;
|
|
45
|
+
if (context.getSourceCode().text[end] === eol) end += eol.length;
|
|
46
|
+
return [start, end];
|
|
47
|
+
}
|
|
48
|
+
function genPrependFixer(commentStyle, node, bannerLines, eol, newlines) {
|
|
49
|
+
return function(fixer) {
|
|
50
|
+
return fixer.insertTextBefore(node, genCommentBody(commentStyle, bannerLines, eol, newlines));
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
function genReplaceFixer(commentStyle, context, leadingComments, bannerLines, eol, newlines) {
|
|
54
|
+
return function(fixer) {
|
|
55
|
+
return fixer.replaceTextRange(genCommentsRange(context, leadingComments, eol), genCommentBody(commentStyle, bannerLines, eol, newlines));
|
|
56
|
+
};
|
|
57
|
+
}
|
|
58
|
+
function getEOL(options) {
|
|
59
|
+
if (options.lineEndings === "unix") return "\n";
|
|
60
|
+
if (options.lineEndings === "windows") return "\r\n";
|
|
61
|
+
return EOL;
|
|
62
|
+
}
|
|
63
|
+
function hasBanner(commentStyle = "block", src, eol) {
|
|
64
|
+
if (src.startsWith("#!")) {
|
|
65
|
+
const bannerLines = src.split(eol);
|
|
66
|
+
if (bannerLines && bannerLines.length > 1) {
|
|
67
|
+
bannerLines.shift();
|
|
68
|
+
while (bannerLines.length && bannerLines[0] && !bannerLines[0].trim()) bannerLines.shift();
|
|
69
|
+
if (bannerLines.length) src = bannerLines.join(eol);
|
|
70
|
+
else return false;
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
return commentStyle === "block" && src.startsWith("/*") || commentStyle === "line" && src.startsWith("//") || commentStyle !== "block" && commentStyle !== "line" && commentStyle && src.startsWith(commentStyle);
|
|
74
|
+
}
|
|
75
|
+
function matchesLineEndings(src, num) {
|
|
76
|
+
for (let j = 0; j < num; ++j) {
|
|
77
|
+
const m = src.match(/^(\r\n|\r|\n)/);
|
|
78
|
+
if (m) src = src.slice((m.index ?? 0) + m[0].length);
|
|
79
|
+
else return false;
|
|
80
|
+
}
|
|
81
|
+
return true;
|
|
82
|
+
}
|
|
83
|
+
var banner_default = createRule({
|
|
84
|
+
name: RULE_NAME,
|
|
85
|
+
meta: {
|
|
86
|
+
docs: { description: "Ensures the file has a organization specific banner at the top of source code files" },
|
|
87
|
+
schema: [{
|
|
88
|
+
type: "object",
|
|
89
|
+
properties: {
|
|
90
|
+
name: {
|
|
91
|
+
type: "string",
|
|
92
|
+
description: "The name of the repository to use when reading the banner from a file."
|
|
93
|
+
},
|
|
94
|
+
license: {
|
|
95
|
+
type: "string",
|
|
96
|
+
description: "The project license to include in the banner."
|
|
97
|
+
},
|
|
98
|
+
organization: {
|
|
99
|
+
type: "string",
|
|
100
|
+
description: "The organization to include in the banner."
|
|
101
|
+
},
|
|
102
|
+
licensing: {
|
|
103
|
+
type: "string",
|
|
104
|
+
description: "The licensing URL to include in the banner."
|
|
105
|
+
},
|
|
106
|
+
repository: {
|
|
107
|
+
type: "string",
|
|
108
|
+
description: "The repository URL to include in the banner."
|
|
109
|
+
},
|
|
110
|
+
docs: {
|
|
111
|
+
type: "string",
|
|
112
|
+
description: "The documentation URL to include in the banner."
|
|
113
|
+
},
|
|
114
|
+
homepage: {
|
|
115
|
+
type: "string",
|
|
116
|
+
description: "The homepage URL to include in the banner."
|
|
117
|
+
},
|
|
118
|
+
commentStyle: {
|
|
119
|
+
type: "string",
|
|
120
|
+
description: "The comment token to use for the banner. Defaults to block ('/* <banner> */')"
|
|
121
|
+
},
|
|
122
|
+
newlines: {
|
|
123
|
+
type: "number",
|
|
124
|
+
description: "The number of newlines to use after the banner. Defaults to 1"
|
|
125
|
+
},
|
|
126
|
+
lineEndings: {
|
|
127
|
+
type: "string",
|
|
128
|
+
enum: ["unix", "windows"],
|
|
129
|
+
description: "The type of line endings to use. Defaults to the system default"
|
|
130
|
+
}
|
|
131
|
+
},
|
|
132
|
+
additionalProperties: false,
|
|
133
|
+
required: ["name"]
|
|
134
|
+
}],
|
|
135
|
+
type: "layout",
|
|
136
|
+
messages: {
|
|
137
|
+
missingBanner: "Missing banner",
|
|
138
|
+
incorrectComment: "Banner should use the {{commentStyle}} comment type",
|
|
139
|
+
incorrectBanner: "Incorrect banner",
|
|
140
|
+
noNewlineAfterBanner: "No newline after banner"
|
|
141
|
+
},
|
|
142
|
+
fixable: "whitespace"
|
|
143
|
+
},
|
|
144
|
+
defaultOptions: [{
|
|
145
|
+
name: "",
|
|
146
|
+
commentStyle: "block",
|
|
147
|
+
lineEndings: "unix",
|
|
148
|
+
newlines: 2
|
|
149
|
+
}],
|
|
150
|
+
create: (context) => {
|
|
151
|
+
const { name, license, organization, licensing, repository, docs, homepage, commentStyle, newlines, lineEndings } = context.options[0];
|
|
152
|
+
const banner = getBanner({
|
|
153
|
+
name,
|
|
154
|
+
license,
|
|
155
|
+
organization,
|
|
156
|
+
licensing,
|
|
157
|
+
repository,
|
|
158
|
+
docs,
|
|
159
|
+
homepage
|
|
160
|
+
});
|
|
161
|
+
const eol = getEOL({
|
|
162
|
+
lineEndings,
|
|
163
|
+
...context.options[0]
|
|
164
|
+
});
|
|
165
|
+
const bannerLines = banner.split(/\r?\n/);
|
|
166
|
+
const normalizedCommentStyle = commentStyle ?? "block";
|
|
167
|
+
let fixLines = bannerLines;
|
|
168
|
+
return { Program(node) {
|
|
169
|
+
const normalizedNewlines = newlines ?? 1;
|
|
170
|
+
if (!hasBanner(normalizedCommentStyle, context.sourceCode.getText(), eol)) context.report({
|
|
171
|
+
loc: node.loc,
|
|
172
|
+
messageId: "missingBanner",
|
|
173
|
+
fix: genPrependFixer(normalizedCommentStyle, node, fixLines, eol, normalizedNewlines)
|
|
174
|
+
});
|
|
175
|
+
else {
|
|
176
|
+
const leadingComments = getLeadingComments(context, node);
|
|
177
|
+
if (!leadingComments.length) context.report({
|
|
178
|
+
loc: node.loc,
|
|
179
|
+
messageId: "missingBanner",
|
|
180
|
+
fix: genPrependFixer(normalizedCommentStyle, node, fixLines, eol, normalizedNewlines)
|
|
181
|
+
});
|
|
182
|
+
else {
|
|
183
|
+
const firstLeadingComment = leadingComments[0];
|
|
184
|
+
if (!firstLeadingComment) return;
|
|
185
|
+
if (firstLeadingComment.type.toLowerCase() !== normalizedCommentStyle) context.report({
|
|
186
|
+
loc: node.loc,
|
|
187
|
+
messageId: "incorrectComment",
|
|
188
|
+
data: { commentStyle: normalizedCommentStyle },
|
|
189
|
+
fix: genReplaceFixer(normalizedCommentStyle, context, leadingComments, fixLines, eol, normalizedNewlines)
|
|
190
|
+
});
|
|
191
|
+
else if (normalizedCommentStyle === "line") {
|
|
192
|
+
if (leadingComments.length < bannerLines.length) {
|
|
193
|
+
context.report({
|
|
194
|
+
loc: node.loc,
|
|
195
|
+
messageId: "missingBanner",
|
|
196
|
+
fix: genReplaceFixer(normalizedCommentStyle, context, leadingComments, fixLines, eol, normalizedNewlines)
|
|
197
|
+
});
|
|
198
|
+
return;
|
|
199
|
+
}
|
|
200
|
+
for (let i = 0; i < bannerLines.length; i++) {
|
|
201
|
+
const currentLeadingComment = leadingComments[i];
|
|
202
|
+
if (!currentLeadingComment) {
|
|
203
|
+
context.report({
|
|
204
|
+
loc: node.loc,
|
|
205
|
+
messageId: "incorrectBanner",
|
|
206
|
+
fix: genReplaceFixer(normalizedCommentStyle, context, leadingComments, fixLines, eol, normalizedNewlines)
|
|
207
|
+
});
|
|
208
|
+
return;
|
|
209
|
+
}
|
|
210
|
+
if (!match(currentLeadingComment.value, bannerLines[i])) {
|
|
211
|
+
context.report({
|
|
212
|
+
loc: node.loc,
|
|
213
|
+
messageId: "incorrectBanner",
|
|
214
|
+
fix: genReplaceFixer(normalizedCommentStyle, context, leadingComments, fixLines, eol, normalizedNewlines)
|
|
215
|
+
});
|
|
216
|
+
return;
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
const lastLeadingComment = leadingComments[bannerLines.length - 1] ?? leadingComments[leadingComments.length - 1];
|
|
220
|
+
if (!lastLeadingComment) return;
|
|
221
|
+
if (!matchesLineEndings(context.sourceCode.text.substr(lastLeadingComment.range[1], normalizedNewlines * 2), normalizedNewlines)) context.report({
|
|
222
|
+
loc: node.loc,
|
|
223
|
+
messageId: "noNewlineAfterBanner",
|
|
224
|
+
fix: genReplaceFixer(normalizedCommentStyle, context, leadingComments, fixLines, eol, normalizedNewlines)
|
|
225
|
+
});
|
|
226
|
+
} else {
|
|
227
|
+
const firstLeadingComment = leadingComments[0];
|
|
228
|
+
if (!firstLeadingComment) return;
|
|
229
|
+
let leadingLines = [firstLeadingComment.value];
|
|
230
|
+
if (bannerLines.length > 1) leadingLines = firstLeadingComment.value.split(/\r?\n/);
|
|
231
|
+
let hasError = false;
|
|
232
|
+
if (leadingLines.length > bannerLines.length) hasError = true;
|
|
233
|
+
for (let i = 0; !hasError && i < bannerLines.length; i++) if (!match(leadingLines[i] ?? "", bannerLines[i])) hasError = true;
|
|
234
|
+
if (hasError) {
|
|
235
|
+
if (bannerLines.length > 1) fixLines = [fixLines.join(eol)];
|
|
236
|
+
context.report({
|
|
237
|
+
loc: node.loc,
|
|
238
|
+
messageId: "incorrectBanner",
|
|
239
|
+
fix: genReplaceFixer(normalizedCommentStyle, context, leadingComments, fixLines, eol, normalizedNewlines)
|
|
240
|
+
});
|
|
241
|
+
} else if (!matchesLineEndings(context.sourceCode.text.substr(firstLeadingComment.range[1], normalizedNewlines * 2), normalizedNewlines)) context.report({
|
|
242
|
+
loc: node.loc,
|
|
243
|
+
messageId: "noNewlineAfterBanner",
|
|
244
|
+
fix: genReplaceFixer(normalizedCommentStyle, context, leadingComments, fixLines, eol, normalizedNewlines)
|
|
245
|
+
});
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
}
|
|
249
|
+
} };
|
|
250
|
+
}
|
|
251
|
+
});
|
|
252
|
+
//#endregion
|
|
253
|
+
export { RULE_NAME, banner_default as default };
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
# storm-banner/banner
|
|
2
|
+
|
|
3
|
+
📝 Ensures the file has a organization specific banner at the top of source code files.
|
|
4
|
+
|
|
5
|
+
💼 This rule is enabled in the 🌟 `recommended` config.
|
|
6
|
+
|
|
7
|
+
🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
|
|
8
|
+
|
|
9
|
+
<!-- end auto-generated rule header -->
|
|
10
|
+
|
|
11
|
+
## Rule Details
|
|
12
|
+
|
|
13
|
+
This rule enforces that all command handler functions in a project have the correct parameter types as defined by the `shell-shock` package. This helps ensure that command handlers are implemented correctly and can prevent runtime errors due to incorrect parameter types.
|
|
14
|
+
|
|
15
|
+
👎 Examples of **incorrect** code for this rule:
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import ... from "...";
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
👍 Examples of **correct** code for this rule:
|
|
22
|
+
|
|
23
|
+
```ts
|
|
24
|
+
/* -------------------------------------------------------------------
|
|
25
|
+
|
|
26
|
+
🗲 Storm Software - <NAME>
|
|
27
|
+
|
|
28
|
+
This code was released as part of the <NAME> project. <NAME>
|
|
29
|
+
is maintained by Storm Software under the Apache-2.0 license, and is
|
|
30
|
+
free for commercial and private use. For more information, please visit
|
|
31
|
+
our licensing page at https://stormsoftware.com/licenses/projects/<NAME>.
|
|
32
|
+
|
|
33
|
+
Website: https://stormsoftware.com
|
|
34
|
+
Repository: https://github.com/storm-software/<NAME>
|
|
35
|
+
Documentation: https://docs.stormsoftware.com/projects/<NAME>
|
|
36
|
+
Contact: https://stormsoftware.com/contact
|
|
37
|
+
|
|
38
|
+
SPDX-License-Identifier: Apache-2.0
|
|
39
|
+
|
|
40
|
+
------------------------------------------------------------------- */
|
|
41
|
+
|
|
42
|
+
import ... from "...";
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Version
|
|
46
|
+
|
|
47
|
+
This rule was introduced in version 0.1.0 of `@storm-software/eslint-plugin-banner`.
|
|
48
|
+
|
|
49
|
+
## Options
|
|
50
|
+
|
|
51
|
+
<!-- begin auto-generated rule options list -->
|
|
52
|
+
|
|
53
|
+
| Name | Description | Type | Choices | Required |
|
|
54
|
+
| :------------- | :-------------------------------------------------------------------------- | :----- | :---------------- | :------- |
|
|
55
|
+
| `commentStyle` | The comment token to use for the banner. Defaults to block ('/_<banner>_/') | String | | |
|
|
56
|
+
| `docs` | The documentation URL to include in the banner. | String | | |
|
|
57
|
+
| `homepage` | The homepage URL to include in the banner. | String | | |
|
|
58
|
+
| `license` | The project license to include in the banner. | String | | |
|
|
59
|
+
| `licensing` | The licensing URL to include in the banner. | String | | |
|
|
60
|
+
| `lineEndings` | The type of line endings to use. Defaults to the system default | String | `unix`, `windows` | |
|
|
61
|
+
| `name` | The name of the repository to use when reading the banner from a file. | String | | Yes |
|
|
62
|
+
| `newlines` | The number of newlines to use after the banner. Defaults to 1 | Number | | |
|
|
63
|
+
| `organization` | The organization to include in the banner. | String | | |
|
|
64
|
+
| `repository` | The repository URL to include in the banner. | String | | |
|
|
65
|
+
|
|
66
|
+
<!-- end auto-generated rule options list -->
|
|
67
|
+
|
|
68
|
+
## Config
|
|
69
|
+
|
|
70
|
+
| | Name |
|
|
71
|
+
| :-- | :------------ |
|
|
72
|
+
| 🌟 | `recommended` |
|
package/package.json
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@storm-software/eslint-plugin-banner",
|
|
3
|
+
"version": "0.0.2",
|
|
4
|
+
"private": false,
|
|
5
|
+
"description": "An ESLint Plugin that enforces the existence of file banners in Storm Software projects.",
|
|
6
|
+
"keywords": ["eslint", "eslint-plugin", "storm-software"],
|
|
7
|
+
"homepage": "https://stormsoftware.com",
|
|
8
|
+
"bugs": {
|
|
9
|
+
"url": "https://stormsoftware.com/support",
|
|
10
|
+
"email": "support@stormsoftware.com"
|
|
11
|
+
},
|
|
12
|
+
"repository": {
|
|
13
|
+
"type": "github",
|
|
14
|
+
"url": "https://github.com/storm-software/storm-ops.git",
|
|
15
|
+
"directory": "packages/eslint-plugin-banner"
|
|
16
|
+
},
|
|
17
|
+
"funding": {
|
|
18
|
+
"type": "github",
|
|
19
|
+
"url": "https://github.com/sponsors/storm-software"
|
|
20
|
+
},
|
|
21
|
+
"license": "Apache-2.0",
|
|
22
|
+
"author": {
|
|
23
|
+
"name": "Storm Software",
|
|
24
|
+
"email": "contact@stormsoftware.com",
|
|
25
|
+
"url": "https://stormsoftware.com"
|
|
26
|
+
},
|
|
27
|
+
"maintainers": [
|
|
28
|
+
{
|
|
29
|
+
"name": "Storm Software",
|
|
30
|
+
"email": "contact@stormsoftware.com",
|
|
31
|
+
"url": "https://stormsoftware.com"
|
|
32
|
+
}
|
|
33
|
+
],
|
|
34
|
+
"contributors": [
|
|
35
|
+
{
|
|
36
|
+
"name": "Storm Software",
|
|
37
|
+
"email": "contact@stormsoftware.com",
|
|
38
|
+
"url": "https://stormsoftware.com"
|
|
39
|
+
}
|
|
40
|
+
],
|
|
41
|
+
"type": "module",
|
|
42
|
+
"exports": {
|
|
43
|
+
".": "./dist/index.mjs",
|
|
44
|
+
"./configs": "./dist/configs/index.mjs",
|
|
45
|
+
"./configs/recommended": "./dist/configs/recommended.mjs",
|
|
46
|
+
"./helpers/create-rule": "./dist/helpers/create-rule.mjs",
|
|
47
|
+
"./helpers/get-banner": "./dist/helpers/get-banner.mjs",
|
|
48
|
+
"./plugin": "./dist/plugin.mjs",
|
|
49
|
+
"./rules/banner": "./dist/rules/banner.mjs",
|
|
50
|
+
"./package.json": "./package.json"
|
|
51
|
+
},
|
|
52
|
+
"types": "./dist/index.d.ts",
|
|
53
|
+
"typings": "dist/index.d.mts",
|
|
54
|
+
"files": ["dist", "docs"],
|
|
55
|
+
"dependencies": {
|
|
56
|
+
"@storm-software/package-constants": "0.1.54",
|
|
57
|
+
"@typescript-eslint/utils": "^8.60.1",
|
|
58
|
+
"defu": "^6.1.7"
|
|
59
|
+
},
|
|
60
|
+
"devDependencies": {
|
|
61
|
+
"@eslint/compat": "^2.1.0",
|
|
62
|
+
"@eslint/config-inspector": "^1.5.0",
|
|
63
|
+
"@storm-software/prettier": "0.59.93",
|
|
64
|
+
"@types/eslint": "^9.6.1",
|
|
65
|
+
"@types/eslint__js": "^8.42.3",
|
|
66
|
+
"@types/node": "^25.9.2",
|
|
67
|
+
"eslint": "^9.39.4",
|
|
68
|
+
"eslint-doc-generator": "^3.6.0",
|
|
69
|
+
"eslint-flat-config-utils": "^2.1.4",
|
|
70
|
+
"eslint-plugin-eslint-plugin": "^7.4.0",
|
|
71
|
+
"eslint-plugin-i18n-text": "^1.0.1",
|
|
72
|
+
"eslint-rule-documentation": "^1.0.23",
|
|
73
|
+
"eslint-typegen": "^2.3.1",
|
|
74
|
+
"tsdown": "^0.22.2"
|
|
75
|
+
},
|
|
76
|
+
"peerDependencies": { "eslint": ">=9.39.3" },
|
|
77
|
+
"peerDependenciesMeta": { "eslint": { "optional": false } },
|
|
78
|
+
"publishConfig": { "access": "public" },
|
|
79
|
+
"gitHead": "8b04bd1c84001d6ac81a2ca2348660b2c8a2f52f"
|
|
80
|
+
}
|