@codesweep-ai/lint 0.0.0-20260915074254-271c4a39b67b

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,2 @@
+Codesweep Lint
+Copyright 2026 CodeSweep Inc.

package/README.md

@@ -0,0 +1,90 @@
+# @codesweep-ai/lint
+
+> **Various linters: doc style, doc correctness, open-source readiness, and more.**
+
+[![CI](https://github.com/codesweep-ai/lint/actions/workflows/ci.yml/badge.svg)](https://github.com/codesweep-ai/lint/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/codesweep-ai/lint/blob/main/LICENSE)
+![Rules](https://img.shields.io/badge/rules-105-informational)
+
+`cs-lint` is a linter for repositories. It has four commands:
+
+- **`cs-lint prose`** checks how the documentation is written.
+- **`cs-lint refs`** checks that everything the documentation points at is
+  still there.
+- **`cs-lint surface`** checks that the documented interface is the real one.
+- **`cs-lint oss`** checks that the repository has what an open-source project
+  needs.
+
+Each one prints a rule number, what is wrong, and the file and line to look at.
+Each exits non-zero when it finds something, so you can run it in CI.
+
+The linter is written in Go, and packaged here for npm projects.
+
+## Quickstart
+
+```bash
+npm install --save-dev @codesweep-ai/lint
+
+cd ~/code/my-project
+cs-lint prose          # how the documents are written
+cs-lint refs           # whether everything they point at is there
+cs-lint oss            # what a published repository owes a reader
+cs-lint surface        # whether the documented interface is the real one
+```
+
+A repository with nothing to tune needs no configuration. To tune one, write
+`.cs-lint.yaml` at its root:
+
+```yaml
+docs:
+  documents: [README.md, MANUAL.md, SPEC.md]   # read by refs and surface
+
+  prose:
+    glossary: [cassette, ruleset]     # terms a reader cannot infer
+    lowercaseStarters: [my-tool]      # the command name, which starts sentences
+
+  refs:
+    placeholderOK: [my-project]       # paths a page leaves to the reader
+
+  surface:
+    tool: my-tool
+    toolPath: bin/my-tool
+    safeVerbs: [version, status]      # read-only verbs a sample check may re-run
+
+oss:
+  project: my-tool
+  githubRepo: acme/my-tool
+```
+
+Then wire it into the one command a contributor already runs:
+
+```json
+{
+  "scripts": {
+    "docs:prose": "cs-lint prose",
+    "docs:refs": "cs-lint refs",
+    "oss": "cs-lint oss",
+    "check": "npm run docs:prose && npm run docs:refs && npm run oss && npm test"
+  }
+}
+```
+
+## Docs
+
+The documentation lives in the [codesweep-ai/lint](https://github.com/codesweep-ai/lint)
+GitHub repository, and none of it ships in this package.
+
+- [INSTALL.md](https://github.com/codesweep-ai/lint/blob/main/INSTALL.md) · how to get the tool, and the setup it needs once
+- [MANUAL.md](https://github.com/codesweep-ai/lint/blob/main/MANUAL.md) · the full surface: commands, options, settings, exit codes
+- [SPEC.md](https://github.com/codesweep-ai/lint/blob/main/SPEC.md) · what the behaviour must be, and what is left open
+- [CONTRIBUTING.md](https://github.com/codesweep-ai/lint/blob/main/CONTRIBUTING.md) · conventions, and the rituals a diff does not show
+- [AGENTS.md](https://github.com/codesweep-ai/lint/blob/main/AGENTS.md) · where an agent looks first
+
+## Contributing
+
+Read [CONTRIBUTING.md](https://github.com/codesweep-ai/lint/blob/main/CONTRIBUTING.md).
+It applies to coding agents as well as to people.
+
+## License
+
+[Apache-2.0](https://github.com/codesweep-ai/lint/blob/main/LICENSE).

package/bin/cs-lint.mjs

@@ -0,0 +1,58 @@
+#!/usr/bin/env node
+// The command `npx cs-lint` runs. It finds the binary for this machine and
+// becomes it: same arguments, same streams, same exit status.
+//
+// Nothing here interprets the run. cs-lint separates three exits — 0 nothing
+// found, 1 something found, 2 could not run at all — and a gate reads all
+// three, so a launcher that collapsed them would report a broken run as a
+// passing one. The status is passed through untouched, and the launcher's own
+// failures exit 2, which is the code that already means the linter did not get
+// to run.
+
+import { spawnSync } from "node:child_process";
+import { constants } from "node:os";
+import { binaryPath } from "../index.mjs";
+
+// The exit code cs-lint uses for a run that could not happen. A launcher that
+// cannot find its binary is one of those.
+const COULD_NOT_RUN = 2;
+
+let bin;
+try {
+  bin = binaryPath();
+} catch (err) {
+  console.error(`cs-lint: ${err.message}`);
+  process.exit(COULD_NOT_RUN);
+}
+
+const result = spawnSync(bin, process.argv.slice(2), {
+  // The linter writes a report for a person and reads nothing, so the streams
+  // are the parent's. Piping them would buffer the report until the run ended
+  // and drop the colours a terminal would have got.
+  stdio: "inherit",
+  // Large reports on stdout are the normal case for a first run against a
+  // repository that has never been linted.
+  maxBuffer: Infinity,
+});
+
+if (result.error) {
+  const { code } = result.error;
+  const hint =
+    code === "ENOENT"
+      ? "the file is missing; reinstall with `rm -rf node_modules && npm install`"
+      : code === "EACCES"
+        ? "the file is not executable; some archive tools drop the permission bit"
+        : result.error.message;
+  console.error(`cs-lint: cannot run ${bin}: ${hint}`);
+  process.exit(COULD_NOT_RUN);
+}
+
+// A binary killed by a signal has no exit code. Reporting the shell's
+// 128 + signal keeps a Ctrl-C from reading as a clean run, which is what a
+// bare `process.exit(result.status)` would produce, since status is null here.
+if (result.signal) {
+  console.error(`cs-lint: killed by ${result.signal}`);
+  process.exit(128 + (constants.signals[result.signal] ?? 0));
+}
+
+process.exit(result.status ?? COULD_NOT_RUN);

package/index.mjs

@@ -0,0 +1,95 @@
+// Where the binary for this machine is.
+//
+// The binaries themselves ship as one package per platform, each marked with
+// the `os` and `cpu` it is for and listed as an optional dependency of this
+// one. npm installs the single package that matches and skips the rest, so a
+// machine downloads one binary rather than four. This file is the lookup that
+// finds it again at run time.
+//
+// It is exported rather than kept private because a project that wants to run
+// the linter from its own script needs the path, and reaching into another
+// package's directory to guess it is what this export exists to prevent.
+
+import { createRequire } from "node:module";
+
+const require = createRequire(import.meta.url);
+
+// goreleaser names its targets in Go's vocabulary and npm filters installs with
+// its own, so the two have to be mapped. The table is written out rather than
+// derived from a rule, because a platform nobody built for must be a lookup
+// miss that names the ones that exist, not a package name assembled from parts
+// that resolves to nothing.
+//
+// The scope is read from this package's own name, which npm/build.mjs sets to
+// the owner that published it, so a fork's build finds its own binaries.
+const SCOPE = require("./package.json").name.split("/")[0];
+const PACKAGES = {
+  "darwin arm64": `${SCOPE}/lint-darwin-arm64`,
+  "darwin x64": `${SCOPE}/lint-darwin-x64`,
+  "linux arm64": `${SCOPE}/lint-linux-arm64`,
+  "linux x64": `${SCOPE}/lint-linux-x64`,
+};
+
+// Raised when this platform has no build. Distinct from the class below,
+// because the two have different answers: this one is a porting request, and
+// that one is a broken install.
+export class UnsupportedPlatformError extends Error {
+  constructor(platform, arch) {
+    super(
+      `cs-lint has no build for ${platform}/${arch}.\n` +
+        `Built platforms: ${Object.keys(PACKAGES).join(", ").replace(/ (?=\w+,|\w+$)/g, "/")}.\n` +
+        `Ask for one at https://github.com/codesweep-ai/lint/issues, or build from ` +
+        `a clone: https://github.com/codesweep-ai/lint/blob/main/INSTALL.md`,
+    );
+    this.name = "UnsupportedPlatformError";
+    this.platform = platform;
+    this.arch = arch;
+  }
+}
+
+// Raised when the platform is supported but its package is not on disk. Nearly
+// always npm rather than the platform: an install that was copied between
+// machines, or one that hit npm's long-standing bug where an existing
+// node_modules loses optional dependencies. Both are fixed the same way, so the
+// message says so rather than describing the cause.
+export class MissingBinaryError extends Error {
+  constructor(pkg, cause) {
+    super(
+      `cs-lint is installed, but ${pkg} is not.\n` +
+        `That package carries the binary for this platform and installs with ` +
+        `cs-lint itself, so this usually means a node_modules built on another ` +
+        `platform, or npm dropping an optional dependency.\n` +
+        `Reinstall from a clean state:\n` +
+        `  rm -rf node_modules package-lock.json && npm install\n` +
+        `In CI, prefer \`npm ci\` over a restored node_modules cache.`,
+      { cause },
+    );
+    this.name = "MissingBinaryError";
+    this.package = pkg;
+  }
+}
+
+// The absolute path to the cs-lint binary for this machine.
+//
+// CS_LINT_BINARY overrides the lookup entirely. That is what lets this
+// repository run the npm packaging against the binary it just built, rather
+// than against the last one published, so the packaging is tested by the same
+// gate as everything else.
+export function binaryPath() {
+  const override = process.env.CS_LINT_BINARY;
+  if (override) return override;
+
+  const pkg = PACKAGES[`${process.platform} ${process.arch}`];
+  if (!pkg) throw new UnsupportedPlatformError(process.platform, process.arch);
+
+  // Resolved through require rather than joined onto a path, so it is found
+  // wherever the installer put it: nested, hoisted, or linked out of a store by
+  // pnpm or Yarn.
+  try {
+    return require.resolve(`${pkg}/bin/cs-lint`);
+  } catch (cause) {
+    throw new MissingBinaryError(pkg, cause);
+  }
+}
+
+export default binaryPath;

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@codesweep-ai/lint",
+  "version": "0.0.0-20260915074254-271c4a39b67b",
+  "description": "Four linters over one repository: how its documents are written, whether every reference resolves, whether the documented interface is the real one, and what a published repository owes a reader.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "engines": {
+    "node": ">=18.17"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/codesweep-ai/lint.git",
+    "directory": "npm/lint"
+  },
+  "homepage": "https://github.com/codesweep-ai/lint#readme",
+  "bugs": {
+    "url": "https://github.com/codesweep-ai/lint/issues"
+  },
+  "keywords": [
+    "ai-agents",
+    "developer-tools",
+    "documentation",
+    "golang",
+    "linter"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "cs-lint": "bin/cs-lint.mjs"
+  },
+  "exports": {
+    ".": "./index.mjs",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "bin",
+    "index.mjs",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "optionalDependencies": {
+    "@codesweep-ai/lint-darwin-arm64": "0.0.0-20260915074254-271c4a39b67b",
+    "@codesweep-ai/lint-darwin-x64": "0.0.0-20260915074254-271c4a39b67b",
+    "@codesweep-ai/lint-linux-arm64": "0.0.0-20260915074254-271c4a39b67b",
+    "@codesweep-ai/lint-linux-x64": "0.0.0-20260915074254-271c4a39b67b"
+  }
+}