lanekeep 0.3.2__py3-none-win_amd64.whl
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.
|
Binary file
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Fred Souza
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: lanekeep
|
|
3
|
+
Version: 0.3.2
|
|
4
|
+
Summary: Deterministic, AST-based architectural conformance checking
|
|
5
|
+
License: MIT OR Apache-2.0
|
|
6
|
+
Project-URL: Homepage, https://github.com/fmsouza/lanekeep
|
|
7
|
+
Project-URL: Repository, https://github.com/fmsouza/lanekeep
|
|
8
|
+
Project-URL: Changelog, https://github.com/fmsouza/lanekeep/blob/main/CHANGELOG.md
|
|
9
|
+
Author: Fred Souza
|
|
10
|
+
Author-email: 1396615+fmsouza@users.noreply.github.com
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
14
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
15
|
+
Classifier: Programming Language :: Rust
|
|
16
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
17
|
+
Keywords: linter,static-analysis,tree-sitter,typescript,conformance
|
|
18
|
+
Requires-Python: >=3.8
|
|
19
|
+
Description-Content-Type: text/markdown
|
|
20
|
+
|
|
21
|
+
# lanekeep
|
|
22
|
+
|
|
23
|
+
**Deterministic, AST-based architectural conformance checking for AI-generated and human-written code.**
|
|
24
|
+
|
|
25
|
+
[](#license)
|
|
26
|
+
|
|
27
|
+
> **Status: early development.** Nothing is released yet and the CLI described below is not
|
|
28
|
+
> usable. The architecture is settled — see [`docs/architecture.md`](docs/architecture.md) — and
|
|
29
|
+
> the work is tracked as a sequence of milestones. Do not depend on this yet.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## What it is
|
|
34
|
+
|
|
35
|
+
lanekeep is not a linter in the ESLint sense. ESLint enforces language-level correctness.
|
|
36
|
+
lanekeep enforces *project-specific conventions* — the ones a language model has no way to infer
|
|
37
|
+
from the code it is shown, because they live in your team's heads and your reviewers' comments.
|
|
38
|
+
|
|
39
|
+
Every rule is a codified answer to **"the agent keeps doing this wrong."**
|
|
40
|
+
|
|
41
|
+
Rules are TypeScript programs, written in the same language as the code they inspect:
|
|
42
|
+
|
|
43
|
+
```ts
|
|
44
|
+
import { defineRule } from 'lanekeep'
|
|
45
|
+
|
|
46
|
+
export default defineRule({
|
|
47
|
+
id: 'local/no-numeric-sizes',
|
|
48
|
+
severity: 'error',
|
|
49
|
+
|
|
50
|
+
card: {
|
|
51
|
+
message: 'Literal numeric size inside makeStyles',
|
|
52
|
+
remediation: 'Use theme.spacing.*, theme.borderRadius.* or theme.borders.*',
|
|
53
|
+
examples: { bad: 'padding: 12', good: 'padding: theme.spacing.md' },
|
|
54
|
+
},
|
|
55
|
+
|
|
56
|
+
// Matched in Rust, at native speed. Your code runs only on matches.
|
|
57
|
+
query: `
|
|
58
|
+
(pair
|
|
59
|
+
key: (property_identifier) @prop
|
|
60
|
+
value: [(number) (unary_expression operand: (number))] @value) @match
|
|
61
|
+
`,
|
|
62
|
+
|
|
63
|
+
check(ctx, m) {
|
|
64
|
+
if (!/^(padding|margin|gap|borderRadius)/.test(ctx.text(m.prop))) return
|
|
65
|
+
if (Number(ctx.text(m.value)) === 0) return
|
|
66
|
+
|
|
67
|
+
const call = ctx.closestAncestor(m.match, '(call_expression function: (identifier) @f)')
|
|
68
|
+
if (!call) return
|
|
69
|
+
if (!ctx.resolvesToImport(call.f, { module: '@rneui/themed', name: 'makeStyles' })) return
|
|
70
|
+
|
|
71
|
+
ctx.report(m.match)
|
|
72
|
+
},
|
|
73
|
+
})
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
`check` is ordinary TypeScript. Loop, accumulate state, build data structures, read other files,
|
|
77
|
+
import shared helpers — there is no expressiveness ceiling and no DSL to learn beyond the query
|
|
78
|
+
that gates it.
|
|
79
|
+
|
|
80
|
+
## Why it exists
|
|
81
|
+
|
|
82
|
+
An agent that writes code against your codebase will violate your conventions confidently and
|
|
83
|
+
repeatedly, because those conventions are invisible in the code it was shown. Telling it again in
|
|
84
|
+
the next prompt does not scale. Encoding the convention as a rule does.
|
|
85
|
+
|
|
86
|
+
That makes the design constraints unusual for a static analyzer:
|
|
87
|
+
|
|
88
|
+
- **It runs in the inner loop.** Agents and developers invoke it after every edit, so a cold run
|
|
89
|
+
on a couple of thousand files has a sub-second budget and a warm run has a sub-25ms one.
|
|
90
|
+
- **Its output is read by a machine.** Violations are sorted deterministically, because an agent
|
|
91
|
+
that reads the output twice must not see reordering as change.
|
|
92
|
+
- **Every rule carries its own fix.** `message`, `remediation` and `examples` are mandatory
|
|
93
|
+
fields, not documentation — they are the rule card that gets fed back to the agent.
|
|
94
|
+
|
|
95
|
+
## How it stays fast with programmable rules
|
|
96
|
+
|
|
97
|
+
The usual problem with a native tool that runs JavaScript plugins is the boundary between them:
|
|
98
|
+
dispatching into JS once per AST node means tens of thousands of crossings per file.
|
|
99
|
+
|
|
100
|
+
lanekeep dispatches once per **query match** instead. The tree-sitter query runs in Rust across a
|
|
101
|
+
single shared parse; only matches reach your handler. That is typically two to three orders of
|
|
102
|
+
magnitude fewer crossings, and it is the reason a Rust engine still earns its place once rules are
|
|
103
|
+
TypeScript.
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
discover paths (globs, gitignore-aware)
|
|
107
|
+
└─> for each file, in parallel:
|
|
108
|
+
cache key ──hit──> validate tracked deps ──> cached violations + facts
|
|
109
|
+
└─miss─> path and raw-text gates reject before any parse
|
|
110
|
+
└─> parse ─> match queries in Rust
|
|
111
|
+
└─> invoke the TypeScript handler, per match only
|
|
112
|
+
└─> reduce phase: cross-file rules consume facts only, never parse trees
|
|
113
|
+
└─> filter suppressions ─> sort ─> report
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
A warm run with no changes executes no JavaScript at all — every file is a cache hit.
|
|
117
|
+
|
|
118
|
+
## Installation
|
|
119
|
+
|
|
120
|
+
Pick whichever matches the project you are adding it to:
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
npm install --save-dev lanekeep # Node
|
|
124
|
+
pip install lanekeep # Python
|
|
125
|
+
brew install fmsouza/tap/lanekeep # macOS and Linux, system-wide
|
|
126
|
+
cargo install lanekeep-cli # from source
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Or download a binary from the [releases page](https://github.com/fmsouza/lanekeep/releases).
|
|
130
|
+
|
|
131
|
+
A single static binary with the JavaScript engine compiled in. **Neither Node.js nor Python is
|
|
132
|
+
required to run lanekeep**, even though rules are written in TypeScript — a runtime is needed
|
|
133
|
+
only to install it from that ecosystem's index, where it picks which binary to fetch. Nothing
|
|
134
|
+
is pulled in as a dependency either way.
|
|
135
|
+
|
|
136
|
+
Prebuilt for macOS on Apple silicon, Linux on x86-64 and arm64, and Windows on x86-64. The
|
|
137
|
+
Linux binaries are built against glibc 2.17, so they run on anything from RHEL 7 onwards.
|
|
138
|
+
Intel macOS is not prebuilt — `cargo install lanekeep-cli` builds it from source, and both the
|
|
139
|
+
npm launcher and the Homebrew formula say so rather than failing obscurely.
|
|
140
|
+
|
|
141
|
+
See [`docs/releasing.md`](docs/releasing.md) for how a release is cut.
|
|
142
|
+
|
|
143
|
+
## What it looks like
|
|
144
|
+
|
|
145
|
+
```
|
|
146
|
+
$ lanekeep check
|
|
147
|
+
src/also.ts:2:1 error [lanekeep/no-default-export] default export
|
|
148
|
+
→ use a named export, so the symbol has one name every importer must use
|
|
149
|
+
src/bad.ts:2:1 error [lanekeep/no-default-export] default export
|
|
150
|
+
→ use a named export, so the symbol has one name every importer must use
|
|
151
|
+
|
|
152
|
+
✖ 2 error(s) across 2 file(s) checked
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Rules may offer a fix, applied with `--fix`:
|
|
156
|
+
|
|
157
|
+
```
|
|
158
|
+
$ lanekeep check --fix
|
|
159
|
+
fixed 2 violation(s) in 2 file(s)
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
Only fixes a rule marked as behavior-preserving are applied. Anything else is a suggestion —
|
|
163
|
+
shown, never written — because the cautious mistake costs a manual edit and the other one
|
|
164
|
+
rewrites your code silently.
|
|
165
|
+
|
|
166
|
+
Suppressions carry a mandatory reason and an optional expiry, and a directive that does not
|
|
167
|
+
work says so — a missing reason, a bare rule id, or an unreadable date is reported rather
|
|
168
|
+
than silently doing nothing:
|
|
169
|
+
|
|
170
|
+
```ts
|
|
171
|
+
// lanekeep-ignore-next-line lanekeep/no-default-export reason: legacy entry point
|
|
172
|
+
export default parse
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
```
|
|
176
|
+
$ lanekeep check --report-unused-suppressions
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
To start from nothing:
|
|
180
|
+
|
|
181
|
+
```
|
|
182
|
+
$ lanekeep init # a config plus a first rule, both runnable
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
To find out where a run spent its time — the split says whether the query or the code is
|
|
186
|
+
the problem:
|
|
187
|
+
|
|
188
|
+
```
|
|
189
|
+
$ lanekeep check --profile
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
To find out what a rule wants without opening its source:
|
|
193
|
+
|
|
194
|
+
```
|
|
195
|
+
$ lanekeep explain lanekeep/no-default-export
|
|
196
|
+
$ lanekeep rules --json
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
For fast feedback on what you touched:
|
|
200
|
+
|
|
201
|
+
```
|
|
202
|
+
$ lanekeep check --staged # what is about to be committed
|
|
203
|
+
$ lanekeep check --since main # what changed against a ref
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
Both are intersected with the config's `include`/`exclude`, and both skip cross-file rules —
|
|
207
|
+
a whole-corpus rule over a subset gives a wrong answer, not a smaller one, so they are
|
|
208
|
+
skipped and named on stderr rather than quietly producing one.
|
|
209
|
+
|
|
210
|
+
Exit `0` when clean, `1` when violations are found, `2` when the checker could not run —
|
|
211
|
+
a caller has to be able to tell "your code has problems" from "the tool is broken".
|
|
212
|
+
Four output formats: `human` (default), `json` (versioned, stable schema), `sarif` (GitHub
|
|
213
|
+
code scanning), and `agent` — token-minimal, grouped by rule rather than by file, with each
|
|
214
|
+
rule's card stated once instead of once per violation. Diagnostics always go to stderr, so
|
|
215
|
+
piping into a parser works even when something fails.
|
|
216
|
+
|
|
217
|
+
## Documentation
|
|
218
|
+
|
|
219
|
+
| Document | Purpose |
|
|
220
|
+
| --- | --- |
|
|
221
|
+
| [`docs/architecture.md`](docs/architecture.md) | The full design: execution model, host API, cache, milestones |
|
|
222
|
+
| [`docs/built-in-rules.md`](docs/built-in-rules.md) | The rules lanekeep ships with, and their options |
|
|
223
|
+
| [`docs/cross-file-rules.md`](docs/cross-file-rules.md) | Writing a rule that needs a whole-corpus view |
|
|
224
|
+
| [`AGENTS.md`](AGENTS.md) | How to work in this repository — for coding agents and humans alike |
|
|
225
|
+
| [`CONTRIBUTING.md`](CONTRIBUTING.md) | Setup, commands, and the pull request process |
|
|
226
|
+
| [`SECURITY.md`](SECURITY.md) | Threat model and how to report a vulnerability |
|
|
227
|
+
| [`docs/releasing.md`](docs/releasing.md) | How a release is built, gated and published |
|
|
228
|
+
|
|
229
|
+
## Security
|
|
230
|
+
|
|
231
|
+
lanekeep is meant to run as a pre-commit hook and inside CI, which makes it a supply-chain target.
|
|
232
|
+
Rules are executable code, so the posture is about confinement rather than absence:
|
|
233
|
+
|
|
234
|
+
- **No ambient authority.** Rules run in an embedded QuickJS sandbox and reach exactly the host
|
|
235
|
+
functions lanekeep exposes. `fs`, `process`, `child_process`, network and dynamic import are not
|
|
236
|
+
restricted — they do not exist in the context.
|
|
237
|
+
- **No network access.** Ever, in any mode, with no configuration that enables it.
|
|
238
|
+
- **Filesystem confinement.** Reads go through a tracked `ctx.readFile`, confined to the project
|
|
239
|
+
root. Writes happen only under `--fix`, only to matched files, only within reported ranges.
|
|
240
|
+
- **Bounded execution.** A per-invocation timeout, a 15-second global run budget and a per-runtime
|
|
241
|
+
memory ceiling, none disableable — a rule that hangs a pre-commit hook is indistinguishable from
|
|
242
|
+
a broken tool. Breaching any of them cancels the run and exits `2`, rather than reporting a
|
|
243
|
+
partial result as a clean one.
|
|
244
|
+
- **Deterministic by construction.** The sandbox withholds the clock and randomness, so a rule
|
|
245
|
+
cannot introduce nondeterminism even by accident.
|
|
246
|
+
|
|
247
|
+
This bounds blast radius and makes third-party rule sets reviewable. It is not a boundary against
|
|
248
|
+
someone who can already commit to the repository being checked. To report a vulnerability, see
|
|
249
|
+
[`SECURITY.md`](SECURITY.md).
|
|
250
|
+
|
|
251
|
+
## Contributing
|
|
252
|
+
|
|
253
|
+
Contributions are welcome, particularly new built-in rules and new host API surface. Start
|
|
254
|
+
with [`CONTRIBUTING.md`](CONTRIBUTING.md) — `./scripts/setup-dev.sh` installs everything and
|
|
255
|
+
wires the git hooks.
|
|
256
|
+
|
|
257
|
+
All work ships as squashed pull requests with [Conventional Commits](https://www.conventionalcommits.org/)
|
|
258
|
+
titles. `main` is protected and takes no direct pushes.
|
|
259
|
+
|
|
260
|
+
## License
|
|
261
|
+
|
|
262
|
+
Licensed under either of
|
|
263
|
+
|
|
264
|
+
- Apache License, Version 2.0 ([`LICENSE-APACHE`](LICENSE-APACHE) or
|
|
265
|
+
<http://www.apache.org/licenses/LICENSE-2.0>)
|
|
266
|
+
- MIT License ([`LICENSE-MIT`](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
|
|
267
|
+
|
|
268
|
+
at your option.
|
|
269
|
+
|
|
270
|
+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in
|
|
271
|
+
this work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without
|
|
272
|
+
any additional terms or conditions.
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
lanekeep-0.3.2.data/scripts/lanekeep.exe,sha256=ox9s5iyNS-EpwcBc6wbZR6gZLx3cn4C2ucBH238FR5U,9084416
|
|
2
|
+
lanekeep-0.3.2.dist-info/METADATA,sha256=2sUb-wTMWIvz1AydZ4pUM09ZdFH5R838Gfcs1xm_uoI,11623
|
|
3
|
+
lanekeep-0.3.2.dist-info/WHEEL,sha256=SwdbcD4j93yZQoCopuduhrN17bTvD32gIB2uc8vzito,109
|
|
4
|
+
lanekeep-0.3.2.dist-info/LICENSE-MIT,sha256=hvR8c5Dq0PDrzBI3n19ahl5w9YynDeo4Nqzgwb4jCpA,1067
|
|
5
|
+
lanekeep-0.3.2.dist-info/LICENSE-APACHE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
|
|
6
|
+
lanekeep-0.3.2.dist-info/RECORD,,
|