@papermill/cli 0.0.0
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.
- package/LICENSE +21 -0
- package/README.md +26 -0
- package/dist/index.js +16 -0
- package/dist/index.js.map +7 -0
- package/package.json +56 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Papermill
|
|
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.
|
package/README.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# @papermill/cli
|
|
2
|
+
|
|
3
|
+
The command-line interface for [Papermill](https://papermill.io) — generate documents from your terminal.
|
|
4
|
+
|
|
5
|
+
> **Early pre-release (v0.0.0).** This package reserves the name and sets up the
|
|
6
|
+
> toolchain. Commands are not implemented yet; the surface below is a placeholder and
|
|
7
|
+
> will change.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install -g @papermill/cli
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
This adds the `papermill` command to your `PATH`.
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
papermill --help # show the help message
|
|
21
|
+
papermill --version # print the installed version
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## License
|
|
25
|
+
|
|
26
|
+
[MIT](./LICENSE)
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
var t={name:"@papermill/cli",version:"0.0.0",description:"Command-line interface for Papermill",type:"module",bin:{papermill:"dist/index.js"},files:["dist","README.md"],publishConfig:{access:"public",registry:"https://registry.npmjs.org/"},engines:{node:">=20"},repository:{type:"git",url:"git+https://github.com/papermillio/cli.git"},license:"MIT",scripts:{dev:"tsx src/index.ts",build:"mkdir -p dist && node esbuild.config.js src/index.ts dist/index.js && chmod +x dist/index.js",start:"node dist/index.js","type-check":"tsc --noEmit",prettier:"prettier src test --write","prettier:check":"prettier src test --check",lint:"eslint . --fix","lint:check":"eslint .",check:"npm run lint:check && npm run prettier:check && npm run type-check",fix:"npm run lint && npm run prettier",test:"mocha",prepublishOnly:"npm run build"},author:"Papermill",devDependencies:{"@eslint/js":"^9.31.0","@types/chai":"^5.2.3","@types/mocha":"^10.0.10","@types/node":"^24.1.0",chai:"^6.2.2",esbuild:"^0.25.8",eslint:"^9.31.0","eslint-config-prettier":"^10.1.8","eslint-plugin-unused-imports":"^4.1.4",mocha:"^11.7.5",prettier:"^3.5.3",tsx:"^4.21.0",typescript:"^5.8.3","typescript-eslint":"^8.37.0"}};var i=`Papermill CLI
|
|
3
|
+
|
|
4
|
+
Usage:
|
|
5
|
+
papermill [command] [options]
|
|
6
|
+
|
|
7
|
+
Options:
|
|
8
|
+
-v, --version Print the installed version
|
|
9
|
+
-h, --help Show this help message
|
|
10
|
+
|
|
11
|
+
This is an early pre-release (v0.0.0). Commands are not implemented yet.
|
|
12
|
+
`;function s(n){let[e]=n;return e==="--version"||e==="-v"?{stdout:`${t.version}
|
|
13
|
+
`,exitCode:0}:e===void 0||e==="--help"||e==="-h"?{stdout:i,exitCode:0}:{stdout:`Unknown command: ${e}
|
|
14
|
+
|
|
15
|
+
${i}`,exitCode:1}}var{stdout:p,exitCode:o}=s(process.argv.slice(2));process.stdout.write(p);process.exitCode=o;
|
|
16
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../package.json", "../src/cli.ts", "../src/index.ts"],
|
|
4
|
+
"sourcesContent": ["{\n \"name\": \"@papermill/cli\",\n \"version\": \"0.0.0\",\n \"description\": \"Command-line interface for Papermill\",\n \"type\": \"module\",\n \"bin\": {\n \"papermill\": \"dist/index.js\"\n },\n \"files\": [\n \"dist\",\n \"README.md\"\n ],\n \"publishConfig\": {\n \"access\": \"public\",\n \"registry\": \"https://registry.npmjs.org/\"\n },\n \"engines\": {\n \"node\": \">=20\"\n },\n \"repository\": {\n \"type\": \"git\",\n \"url\": \"git+https://github.com/papermillio/cli.git\"\n },\n \"license\": \"MIT\",\n \"scripts\": {\n \"dev\": \"tsx src/index.ts\",\n \"build\": \"mkdir -p dist && node esbuild.config.js src/index.ts dist/index.js && chmod +x dist/index.js\",\n \"start\": \"node dist/index.js\",\n \"type-check\": \"tsc --noEmit\",\n \"prettier\": \"prettier src test --write\",\n \"prettier:check\": \"prettier src test --check\",\n \"lint\": \"eslint . --fix\",\n \"lint:check\": \"eslint .\",\n \"check\": \"npm run lint:check && npm run prettier:check && npm run type-check\",\n \"fix\": \"npm run lint && npm run prettier\",\n \"test\": \"mocha\",\n \"prepublishOnly\": \"npm run build\"\n },\n \"author\": \"Papermill\",\n \"devDependencies\": {\n \"@eslint/js\": \"^9.31.0\",\n \"@types/chai\": \"^5.2.3\",\n \"@types/mocha\": \"^10.0.10\",\n \"@types/node\": \"^24.1.0\",\n \"chai\": \"^6.2.2\",\n \"esbuild\": \"^0.25.8\",\n \"eslint\": \"^9.31.0\",\n \"eslint-config-prettier\": \"^10.1.8\",\n \"eslint-plugin-unused-imports\": \"^4.1.4\",\n \"mocha\": \"^11.7.5\",\n \"prettier\": \"^3.5.3\",\n \"tsx\": \"^4.21.0\",\n \"typescript\": \"^5.8.3\",\n \"typescript-eslint\": \"^8.37.0\"\n }\n}\n", "import pkg from '../package.json' with { type: 'json' }\n\nconst USAGE = `Papermill CLI\n\nUsage:\n papermill [command] [options]\n\nOptions:\n -v, --version Print the installed version\n -h, --help Show this help message\n\nThis is an early pre-release (v0.0.0). Commands are not implemented yet.\n`\n\nexport interface RunResult {\n stdout: string\n exitCode: number\n}\n\n/**\n * Resolves CLI arguments to the text to print and the process exit code, without\n * touching `process` \u2014 so the behaviour can be unit-tested. The bin entry is the only\n * place that writes to stdout and sets the exit code.\n */\nexport function run(argv: string[]): RunResult {\n const [command] = argv\n\n if (command === '--version' || command === '-v') {\n return { stdout: `${pkg.version}\\n`, exitCode: 0 }\n }\n\n if (command === undefined || command === '--help' || command === '-h') {\n return { stdout: USAGE, exitCode: 0 }\n }\n\n return { stdout: `Unknown command: ${command}\\n\\n${USAGE}`, exitCode: 1 }\n}\n", "import { run } from './cli.ts'\n\nconst { stdout, exitCode } = run(process.argv.slice(2))\nprocess.stdout.write(stdout)\nprocess.exitCode = exitCode\n"],
|
|
5
|
+
"mappings": ";AAAA,IAAAA,EAAA,CACE,KAAQ,iBACR,QAAW,QACX,YAAe,uCACf,KAAQ,SACR,IAAO,CACL,UAAa,eACf,EACA,MAAS,CACP,OACA,WACF,EACA,cAAiB,CACf,OAAU,SACV,SAAY,6BACd,EACA,QAAW,CACT,KAAQ,MACV,EACA,WAAc,CACZ,KAAQ,MACR,IAAO,4CACT,EACA,QAAW,MACX,QAAW,CACT,IAAO,mBACP,MAAS,+FACT,MAAS,qBACT,aAAc,eACd,SAAY,4BACZ,iBAAkB,4BAClB,KAAQ,iBACR,aAAc,WACd,MAAS,qEACT,IAAO,mCACP,KAAQ,QACR,eAAkB,eACpB,EACA,OAAU,YACV,gBAAmB,CACjB,aAAc,UACd,cAAe,SACf,eAAgB,WAChB,cAAe,UACf,KAAQ,SACR,QAAW,UACX,OAAU,UACV,yBAA0B,UAC1B,+BAAgC,SAChC,MAAS,UACT,SAAY,SACZ,IAAO,UACP,WAAc,SACd,oBAAqB,SACvB,CACF,ECrDA,IAAMC,EAAQ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAsBP,SAASC,EAAIC,EAA2B,CAC7C,GAAM,CAACC,CAAO,EAAID,EAElB,OAAIC,IAAY,aAAeA,IAAY,KAClC,CAAE,OAAQ,GAAGC,EAAI,OAAO;AAAA,EAAM,SAAU,CAAE,EAG/CD,IAAY,QAAaA,IAAY,UAAYA,IAAY,KACxD,CAAE,OAAQH,EAAO,SAAU,CAAE,EAG/B,CAAE,OAAQ,oBAAoBG,CAAO;AAAA;AAAA,EAAOH,CAAK,GAAI,SAAU,CAAE,CAC1E,CClCA,GAAM,CAAE,OAAAK,EAAQ,SAAAC,CAAS,EAAIC,EAAI,QAAQ,KAAK,MAAM,CAAC,CAAC,EACtD,QAAQ,OAAO,MAAMF,CAAM,EAC3B,QAAQ,SAAWC",
|
|
6
|
+
"names": ["package_default", "USAGE", "run", "argv", "command", "package_default", "stdout", "exitCode", "run"]
|
|
7
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@papermill/cli",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "Command-line interface for Papermill",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"bin": {
|
|
7
|
+
"papermill": "dist/index.js"
|
|
8
|
+
},
|
|
9
|
+
"files": [
|
|
10
|
+
"dist",
|
|
11
|
+
"README.md"
|
|
12
|
+
],
|
|
13
|
+
"publishConfig": {
|
|
14
|
+
"access": "public",
|
|
15
|
+
"registry": "https://registry.npmjs.org/"
|
|
16
|
+
},
|
|
17
|
+
"engines": {
|
|
18
|
+
"node": ">=20"
|
|
19
|
+
},
|
|
20
|
+
"repository": {
|
|
21
|
+
"type": "git",
|
|
22
|
+
"url": "git+https://github.com/papermillio/cli.git"
|
|
23
|
+
},
|
|
24
|
+
"license": "MIT",
|
|
25
|
+
"scripts": {
|
|
26
|
+
"dev": "tsx src/index.ts",
|
|
27
|
+
"build": "mkdir -p dist && node esbuild.config.js src/index.ts dist/index.js && chmod +x dist/index.js",
|
|
28
|
+
"start": "node dist/index.js",
|
|
29
|
+
"type-check": "tsc --noEmit",
|
|
30
|
+
"prettier": "prettier src test --write",
|
|
31
|
+
"prettier:check": "prettier src test --check",
|
|
32
|
+
"lint": "eslint . --fix",
|
|
33
|
+
"lint:check": "eslint .",
|
|
34
|
+
"check": "npm run lint:check && npm run prettier:check && npm run type-check",
|
|
35
|
+
"fix": "npm run lint && npm run prettier",
|
|
36
|
+
"test": "mocha",
|
|
37
|
+
"prepublishOnly": "npm run build"
|
|
38
|
+
},
|
|
39
|
+
"author": "Papermill",
|
|
40
|
+
"devDependencies": {
|
|
41
|
+
"@eslint/js": "^9.31.0",
|
|
42
|
+
"@types/chai": "^5.2.3",
|
|
43
|
+
"@types/mocha": "^10.0.10",
|
|
44
|
+
"@types/node": "^24.1.0",
|
|
45
|
+
"chai": "^6.2.2",
|
|
46
|
+
"esbuild": "^0.25.8",
|
|
47
|
+
"eslint": "^9.31.0",
|
|
48
|
+
"eslint-config-prettier": "^10.1.8",
|
|
49
|
+
"eslint-plugin-unused-imports": "^4.1.4",
|
|
50
|
+
"mocha": "^11.7.5",
|
|
51
|
+
"prettier": "^3.5.3",
|
|
52
|
+
"tsx": "^4.21.0",
|
|
53
|
+
"typescript": "^5.8.3",
|
|
54
|
+
"typescript-eslint": "^8.37.0"
|
|
55
|
+
}
|
|
56
|
+
}
|