Deprecate deps command (#149)

Author: bluwy

.changeset/gentle-parks-mate.md

@@ -0,0 +1,5 @@
+---
+'publint': patch
+---
+
+Deprecate the `deps` command. The command has been tricky to maintain and incomplete (e.g. doesn't lint recursively). A separate tool can be used to run publint on dependencies instead, e.g. `npx renoma --filter-rules "publint"`.

README.md

@@ -23,14 +23,11 @@
 ## Usage
 
 ```bash
-# Lint your library project
+# Lint a library project
 $ npx publint
 
-# Lint a dependency
-$ npx publint ./node_modules/some-lib
-
-# Lint your project's dependencies based on package.json
-$ npx publint deps
+# Lint a given path
+$ npx publint ./packages/my-library
 ```
 
 Or try it online at https://publint.dev. For JavaScript usage, see [packages/publint/README.md](./packages/publint/README.md).

packages/publint/README.md

@@ -27,14 +27,11 @@ This package contains a CLI and API to lint packages locally. The package to be
 ### CLI
 
 ```bash
-# Lint your library project
+# Lint a library project
 $ npx publint
 
-# Lint a dependency
-$ npx publint ./node_modules/some-lib
-
-# Lint your project's dependencies based on package.json
-$ npx publint deps
+# Lint a given path
+$ npx publint ./packages/my-library
 ```
 
 Use `npx publint --help` for more information.

packages/publint/src/cli.js

@@ -64,6 +64,15 @@ cli
   .option('-P, --prod', 'Only check dependencies')
   .option('-D, --dev', 'Only check devDependencies')
   .action(async (dir, opts) => {
+    console.log(
+      c.bold(
+        c.yellow(
+          'The `publint deps` command is deprecated. You can use a different tool to run `publint` in dependencies instead. ' +
+            'e.g. `npx renoma --filter-rules "publint"`',
+        ),
+      ),
+    )
+
     opts = normalizeOpts(opts)
 
     const pkgDir = dir ? path.resolve(dir) : process.cwd()

site/index.html

@@ -66,7 +66,6 @@ <h2>Use locally</h2>
               Run <code>npx publint</code> in your library directory to lint
               locally.
             </li>
-            <li>Run <code>npx publint deps</code> to lint dependencies.</li>
             <li>
               Run <code>npx publint --help</code> for the full list of options.
             </li>

site/src/components/Footer.astro

@@ -40,7 +40,6 @@
         <li>
           Run <code>npx publint</code> in your library directory to lint locally.
         </li>
-        <li>Run <code>npx publint deps</code> to lint dependencies.</li>
         <li>
           Run <code>npx publint --help</code> for the full list of options.
         </li>