palveron 0.0.1

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.
Files changed (3) hide show
  1. package/README.md +28 -0
  2. package/bin/lock.mjs +23 -0
  3. package/package.json +26 -0
package/README.md ADDED
@@ -0,0 +1,28 @@
1
+ # palveron
2
+
3
+ **This is a holding package.** This name belongs to Palveron and is held only so that nobody else can claim it. It will never carry functionality.
4
+
5
+ Running it prints a message to stderr and exits with code 1. Nothing else happens.
6
+
7
+ ## Why this name is held
8
+
9
+ The help output and documentation of @palveron/agent-shield version 0.1.0 showed commands of the form "npx palveron shield init". That form was wrong: "palveron" is the bin inside @palveron/agent-shield, not a package of its own, so npx asks the registry for a package called "palveron", and until now no such package existed.
10
+
11
+ ## What to use instead
12
+
13
+ Install the real package and run the real command:
14
+
15
+ ```
16
+ npm install -g @palveron/agent-shield
17
+ palveron shield init
18
+ ```
19
+
20
+ Without a global install, the -p flag points npx at the right package:
21
+
22
+ ```
23
+ npx -p @palveron/agent-shield palveron shield init
24
+ ```
25
+
26
+ Documentation: https://docs.palveron.com
27
+
28
+ Source of this holding package: https://github.com/palveron/npm-name-locks
package/bin/lock.mjs ADDED
@@ -0,0 +1,23 @@
1
+ #!/usr/bin/env node
2
+ // palveron: holding package. Refuses loudly and names the right way.
3
+ // Message goes to stderr, never stdout, and the process ends with exit code 1
4
+ // on every run, unconditionally. An agent or shell that ran this by mistake
5
+ // must see a failure, not a success with a note attached.
6
+ import { writeSync } from 'node:fs';
7
+
8
+ const MESSAGE = [
9
+ "palveron is a holding package. This name belongs to Palveron and is held only so that nobody else can claim it. It will never carry functionality.",
10
+ "",
11
+ "Why this name is held: The help output and documentation of @palveron/agent-shield version 0.1.0 showed commands of the form \"npx palveron shield init\". That form was wrong: \"palveron\" is the bin inside @palveron/agent-shield, not a package of its own, so npx asks the registry for a package called \"palveron\", and until now no such package existed.",
12
+ "",
13
+ "Install the real package and run the real command:",
14
+ " npm install -g @palveron/agent-shield",
15
+ " palveron shield init",
16
+ "Without a global install, the -p flag points npx at the right package:",
17
+ " npx -p @palveron/agent-shield palveron shield init",
18
+ "",
19
+ "Documentation: https://docs.palveron.com",
20
+ ].join('\n');
21
+
22
+ writeSync(2, MESSAGE + '\n');
23
+ process.exit(1);
package/package.json ADDED
@@ -0,0 +1,26 @@
1
+ {
2
+ "name": "palveron",
3
+ "version": "0.0.1",
4
+ "description": "Holding package. This name belongs to Palveron and is held only so that nobody else can claim it. It will never carry functionality.",
5
+ "license": "MIT",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/palveron/npm-name-locks.git",
9
+ "directory": "packages/palveron"
10
+ },
11
+ "homepage": "https://github.com/palveron/npm-name-locks#readme",
12
+ "bugs": {
13
+ "url": "https://github.com/palveron/npm-name-locks/issues"
14
+ },
15
+ "keywords": [
16
+ "security-holding-package",
17
+ "palveron"
18
+ ],
19
+ "bin": {
20
+ "palveron": "bin/lock.mjs"
21
+ },
22
+ "files": [
23
+ "bin",
24
+ "README.md"
25
+ ]
26
+ }