@lanelint/core 0.0.0-stage → 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Anton Ödman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,81 @@
-# Temporary Holding Version
+# @lanelint/core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![npm](https://img.shields.io/npm/v/@lanelint/core)](https://www.npmjs.com/package/@lanelint/core)
+
+The engine and rule API behind [lanelint](https://github.com/banjo/lanelint), for authors of
+plugins. To check a project, install [`lanelint`](https://www.npmjs.com/package/lanelint)
+instead.
+
+## Install
+
+Plugins depend on core as a peer dependency:
+
+```json
+{
+  "peerDependencies": { "@lanelint/core": "^0.1.0" }
+}
+```
+
+## Write a rule
+
+```ts
+import { definePlugin, defineRule } from '@lanelint/core';
+
+const noLegacyImports = defineRule({
+  meta: {
+    description: 'New code must not import from src/legacy.',
+    severity: 'error',
+    docs: 'src/legacy is being removed. To fix a finding, use the replacement in src/common.',
+  },
+  create: (context) => ({
+    import(edge) {
+      if (edge.target.type === 'internal' && edge.target.file.path.startsWith('src/legacy/')) {
+        context.report({ at: edge, message: `Do not import ${edge.target.file.path}.` });
+      }
+    },
+  }),
+});
+
+export default definePlugin({ name: 'legacy', rules: { 'no-legacy-imports': noLegacyImports } });
+```
+
+Options take any [Standard Schema](https://standardschema.dev), such as Zod, Valibot, or
+ArkType, and their types flow into `defineConfig`.
+
+## Test a rule
+
+```ts
+import { testRule } from '@lanelint/core/testing';
+import { describe, expect, it } from 'vitest';
+
+testRule(
+  'legacy/no-legacy-imports',
+  noLegacyImports,
+  {
+    valid: [
+      { files: { 'src/a.ts': "import { b } from './b.ts';", 'src/b.ts': 'export const b = 1;' } },
+    ],
+    invalid: [
+      {
+        files: {
+          'src/a.ts': "import { c } from './legacy/c.ts';",
+          'src/legacy/c.ts': 'export const c = 1;',
+        },
+        findings: [{ path: 'src/a.ts', line: 1 }],
+      },
+    ],
+  },
+  { describe, it, expect },
+);
+```
+
+## Docs
+
+- [Writing rules](https://github.com/banjo/lanelint/blob/main/docs/writing-rules.md): visitors,
+  context, options, tests, and publishing
+- [Concepts](https://github.com/banjo/lanelint/blob/main/docs/concepts.md): elements, imports,
+  and findings
+
+## License
+
+MIT