@ldo/cli 0.0.1-1.0.0-alpha.1.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.txt +21 -0
- package/README.md +83 -0
- package/dist/build.d.ts +6 -0
- package/dist/build.js +51 -0
- package/dist/build.js.map +1 -0
- package/dist/create.d.ts +1 -0
- package/dist/create.js +98 -0
- package/dist/create.js.map +1 -0
- package/dist/generateReadme.d.ts +11 -0
- package/dist/generateReadme.js +59 -0
- package/dist/generateReadme.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +37 -0
- package/dist/index.js.map +1 -0
- package/dist/init.d.ts +1 -0
- package/dist/init.js +49 -0
- package/dist/init.js.map +1 -0
- package/dist/templates/context.ejs +8 -0
- package/dist/templates/defaultShapes/foafProfile.ejs +19 -0
- package/dist/templates/readme/main.ejs +15 -0
- package/dist/templates/readme/projectIndex.ejs +2 -0
- package/dist/templates/readme/shape.ejs +27 -0
- package/dist/templates/schema.ejs +8 -0
- package/dist/templates/shapeTypes.ejs +24 -0
- package/dist/templates/typings.ejs +14 -0
- package/dist/util/forAllShapes.d.ts +1 -0
- package/dist/util/forAllShapes.js +21 -0
- package/dist/util/forAllShapes.js.map +1 -0
- package/dist/util/modifyPackageJson.d.ts +4 -0
- package/dist/util/modifyPackageJson.js +24 -0
- package/dist/util/modifyPackageJson.js.map +1 -0
- package/package.json +67 -0
- package/src/build.ts +66 -0
- package/src/create.ts +111 -0
- package/src/generateReadme.ts +101 -0
- package/src/index.ts +53 -0
- package/src/init.ts +73 -0
- package/src/templates/context.ejs +8 -0
- package/src/templates/defaultShapes/foafProfile.ejs +19 -0
- package/src/templates/readme/main.ejs +15 -0
- package/src/templates/readme/projectIndex.ejs +2 -0
- package/src/templates/readme/shape.ejs +27 -0
- package/src/templates/schema.ejs +8 -0
- package/src/templates/shapeTypes.ejs +24 -0
- package/src/templates/typings.ejs +14 -0
- package/src/util/forAllShapes.ts +26 -0
- package/src/util/modifyPackageJson.ts +33 -0
package/LICENSE.txt
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2023 Jackson Morgan
|
|
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,83 @@
|
|
|
1
|
+
# @ldo/cli
|
|
2
|
+
|
|
3
|
+
The `@ldo/cli` is a command line interface for initializing LDO and building ShapeTypes.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
### Automatic Setup
|
|
8
|
+
To setup LDO, `cd` into your typescript project and run `npx @ldo/cli init`.
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
cd my-typescript-project
|
|
12
|
+
npx @ldo/cli init
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
<details>
|
|
16
|
+
<summary>
|
|
17
|
+
Manual Setup
|
|
18
|
+
</summary>
|
|
19
|
+
The following is handled by the __automatic setup__:
|
|
20
|
+
|
|
21
|
+
Install the LDO dependencies.
|
|
22
|
+
```bash
|
|
23
|
+
npm install @ldo/ldo
|
|
24
|
+
npm install @ldo/cli --save-dev
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Create a folder to store your ShEx shapes:
|
|
28
|
+
```bash
|
|
29
|
+
mkdir shapes
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Create a script to build ShEx shapes and convert them into Linked Data Objects. You can put this script in `package.json`
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
...
|
|
36
|
+
scripts: {
|
|
37
|
+
...
|
|
38
|
+
"build:ldo": "ldo build --input ./shapes --output ./ldo"
|
|
39
|
+
...
|
|
40
|
+
}
|
|
41
|
+
...
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
</details>
|
|
45
|
+
|
|
46
|
+
## Generating a ShapeType
|
|
47
|
+
|
|
48
|
+
@ldo/cli generates shape types using the `*.shex` files in the "input" folder. If you followed the instructions above, run the following command:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npm run build:ldo
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
This will generate five files:
|
|
55
|
+
- `./ldo/foafProfile.shapeTypes.ts` <-- This is the important file
|
|
56
|
+
- `./ldo/foafProfile.typings.ts`
|
|
57
|
+
- `./ldo/foafProfile.schema.ts`
|
|
58
|
+
- `./ldo/foafProfile.context.ts`
|
|
59
|
+
|
|
60
|
+
## Creating a new project to distribure shapes
|
|
61
|
+
|
|
62
|
+
Sometimes, you might want to distribute shapes to others. The easiest way to do that is to deploy them to NPM. The LDO CLI has an easy-to-use command for generating a standalone project just for your shapes.
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
npx @ldo/cli create ./my-project
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
This script will generate a project with a place to put your shapes. Running `npm publish` will build the shapes and push to project to NPM for you.
|
|
69
|
+
|
|
70
|
+
## API Details
|
|
71
|
+
- [`init` command](https://ldo.js.org/latest/api/cli/init/)
|
|
72
|
+
- [`build` command](https://ldo.js.org/latest/api/cli/build/)
|
|
73
|
+
- [`create` command](https://ldo.js.org/latest/api/cli/create/)
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
## Sponsorship
|
|
77
|
+
This project was made possible by a grant from NGI Zero Entrust via nlnet. Learn more on the [NLnet project page](https://nlnet.nl/project/SolidUsableApps/).
|
|
78
|
+
|
|
79
|
+
[<img src="https://nlnet.nl/logo/banner.png" alt="nlnet foundation logo" width="300" />](https://nlnet.nl/)
|
|
80
|
+
[<img src="https://nlnet.nl/image/logos/NGI0Entrust_tag.svg" alt="NGI Zero Entrust Logo" width="300" />](https://nlnet.nl/)
|
|
81
|
+
|
|
82
|
+
## Liscense
|
|
83
|
+
MIT
|
package/dist/build.d.ts
ADDED
package/dist/build.js
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.build = void 0;
|
|
7
|
+
const fs_extra_1 = __importDefault(require("fs-extra"));
|
|
8
|
+
const path_1 = __importDefault(require("path"));
|
|
9
|
+
const parser_1 = __importDefault(require("@shexjs/parser"));
|
|
10
|
+
const schema_converter_shex_1 = __importDefault(require("@ldo/schema-converter-shex"));
|
|
11
|
+
const ejs_1 = require("ejs");
|
|
12
|
+
const prettier_1 = __importDefault(require("prettier"));
|
|
13
|
+
const loading_cli_1 = __importDefault(require("loading-cli"));
|
|
14
|
+
const forAllShapes_1 = require("./util/forAllShapes");
|
|
15
|
+
async function build(options) {
|
|
16
|
+
const load = (0, loading_cli_1.default)("Peparing Environment");
|
|
17
|
+
load.start();
|
|
18
|
+
if (fs_extra_1.default.existsSync(options.output)) {
|
|
19
|
+
await fs_extra_1.default.promises.rm(options.output, { recursive: true });
|
|
20
|
+
}
|
|
21
|
+
await fs_extra_1.default.promises.mkdir(options.output);
|
|
22
|
+
load.text = "Generating LDO Documents";
|
|
23
|
+
await (0, forAllShapes_1.forAllShapes)(options.input, async (fileName, shexC) => {
|
|
24
|
+
let schema;
|
|
25
|
+
try {
|
|
26
|
+
schema = parser_1.default.construct("https://ldo.js.org/").parse(shexC);
|
|
27
|
+
}
|
|
28
|
+
catch (err) {
|
|
29
|
+
const errMessage = err instanceof Error
|
|
30
|
+
? err.message
|
|
31
|
+
: typeof err === "string"
|
|
32
|
+
? err
|
|
33
|
+
: "Unknown Error";
|
|
34
|
+
console.error(`Error processing ${fileName}: ${errMessage}`);
|
|
35
|
+
return;
|
|
36
|
+
}
|
|
37
|
+
const [typings, context] = await (0, schema_converter_shex_1.default)(schema);
|
|
38
|
+
await Promise.all(["context", "schema", "shapeTypes", "typings"].map(async (templateName) => {
|
|
39
|
+
const finalContent = await (0, ejs_1.renderFile)(path_1.default.join(__dirname, "./templates", `${templateName}.ejs`), {
|
|
40
|
+
typings: typings.typings,
|
|
41
|
+
fileName,
|
|
42
|
+
schema: JSON.stringify(schema, null, 2),
|
|
43
|
+
context: JSON.stringify(context, null, 2),
|
|
44
|
+
});
|
|
45
|
+
await fs_extra_1.default.promises.writeFile(path_1.default.join(options.output, `${fileName}.${templateName}.ts`), await prettier_1.default.format(finalContent, { parser: "typescript" }));
|
|
46
|
+
}));
|
|
47
|
+
});
|
|
48
|
+
load.stop();
|
|
49
|
+
}
|
|
50
|
+
exports.build = build;
|
|
51
|
+
//# sourceMappingURL=build.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"build.js","sourceRoot":"","sources":["../src/build.ts"],"names":[],"mappings":";;;;;;AAAA,wDAA0B;AAC1B,gDAAwB;AAExB,4DAAoC;AACpC,uFAA6D;AAC7D,6BAAiC;AACjC,wDAAgC;AAChC,8DAAkC;AAClC,sDAAmD;AAO5C,KAAK,UAAU,KAAK,CAAC,OAAqB;IAC/C,MAAM,IAAI,GAAG,IAAA,qBAAO,EAAC,sBAAsB,CAAC,CAAC;IAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;IAEb,IAAI,kBAAE,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACjC,MAAM,kBAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;KAC3D;IACD,MAAM,kBAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAExC,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;IACvC,MAAM,IAAA,2BAAY,EAAC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE;QAE1D,IAAI,MAAc,CAAC;QACnB,IAAI;YACF,MAAM,GAAG,gBAAM,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;SAC/D;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,UAAU,GACd,GAAG,YAAY,KAAK;gBAClB,CAAC,CAAC,GAAG,CAAC,OAAO;gBACb,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ;oBACzB,CAAC,CAAC,GAAG;oBACL,CAAC,CAAC,eAAe,CAAC;YACtB,OAAO,CAAC,KAAK,CAAC,oBAAoB,QAAQ,KAAK,UAAU,EAAE,CAAC,CAAC;YAC7D,OAAO;SACR;QAED,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,MAAM,IAAA,+BAAmB,EAAC,MAAM,CAAC,CAAC;QAC7D,MAAM,OAAO,CAAC,GAAG,CACf,CAAC,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC,GAAG,CAChD,KAAK,EAAE,YAAY,EAAE,EAAE;YACrB,MAAM,YAAY,GAAG,MAAM,IAAA,gBAAU,EACnC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,EAAE,GAAG,YAAY,MAAM,CAAC,EAC1D;gBACE,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,QAAQ;gBACR,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;gBACvC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;aAC1C,CACF,CAAC;YAEF,MAAM,kBAAE,CAAC,QAAQ,CAAC,SAAS,CACzB,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,QAAQ,IAAI,YAAY,KAAK,CAAC,EAC3D,MAAM,kBAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAC9D,CAAC;QACJ,CAAC,CACF,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,IAAI,EAAE,CAAC;AACd,CAAC;AAlDD,sBAkDC"}
|
package/dist/create.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function create(directory: string): Promise<void>;
|
package/dist/create.js
ADDED
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.create = void 0;
|
|
7
|
+
const init_1 = require("./init");
|
|
8
|
+
const modifyPackageJson_1 = require("./util/modifyPackageJson");
|
|
9
|
+
const generateReadme_1 = require("./generateReadme");
|
|
10
|
+
const path_1 = __importDefault(require("path"));
|
|
11
|
+
const prompts_1 = __importDefault(require("prompts"));
|
|
12
|
+
const loading_cli_1 = __importDefault(require("loading-cli"));
|
|
13
|
+
const fs_1 = require("fs");
|
|
14
|
+
async function create(directory) {
|
|
15
|
+
const responses = await (0, prompts_1.default)([
|
|
16
|
+
{
|
|
17
|
+
type: "text",
|
|
18
|
+
name: "name",
|
|
19
|
+
message: "Package name:",
|
|
20
|
+
initial: path_1.default.basename(directory),
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
type: "text",
|
|
24
|
+
name: "version",
|
|
25
|
+
message: "Version:",
|
|
26
|
+
initial: "1.0.0",
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
type: "text",
|
|
30
|
+
name: "description",
|
|
31
|
+
message: "Description:",
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
type: "list",
|
|
35
|
+
name: "keywords",
|
|
36
|
+
message: "Keywords (comma separated):",
|
|
37
|
+
separator: ",",
|
|
38
|
+
},
|
|
39
|
+
{
|
|
40
|
+
type: "text",
|
|
41
|
+
name: "author",
|
|
42
|
+
message: "Author:",
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
type: "text",
|
|
46
|
+
name: "license",
|
|
47
|
+
message: "License:",
|
|
48
|
+
initial: "MIT",
|
|
49
|
+
},
|
|
50
|
+
{
|
|
51
|
+
type: "text",
|
|
52
|
+
name: "repository",
|
|
53
|
+
message: "Git repository (optional):",
|
|
54
|
+
},
|
|
55
|
+
]);
|
|
56
|
+
const load = (0, loading_cli_1.default)("Generating package.json");
|
|
57
|
+
const packageJson = {
|
|
58
|
+
name: responses.name,
|
|
59
|
+
version: responses.version,
|
|
60
|
+
description: responses.description,
|
|
61
|
+
keywords: responses.keywords,
|
|
62
|
+
author: responses.author,
|
|
63
|
+
license: responses.license,
|
|
64
|
+
main: "./index.js",
|
|
65
|
+
};
|
|
66
|
+
if (responses.repository) {
|
|
67
|
+
packageJson.repository = {
|
|
68
|
+
type: "git",
|
|
69
|
+
url: responses.repository,
|
|
70
|
+
};
|
|
71
|
+
packageJson.bugs = {
|
|
72
|
+
url: `${responses.repository.replace(/\.git$/, "")}/issues`,
|
|
73
|
+
};
|
|
74
|
+
packageJson.homepage = `${responses.repository.replace(/\.git$/, "")}#readme`;
|
|
75
|
+
}
|
|
76
|
+
await (0, modifyPackageJson_1.savePackageJson)(directory, packageJson);
|
|
77
|
+
load.text = "Initializing LDO";
|
|
78
|
+
await (0, init_1.init)(directory);
|
|
79
|
+
await (0, modifyPackageJson_1.modifyPackageJson)(directory, async (packageJson) => {
|
|
80
|
+
if (!packageJson.scripts)
|
|
81
|
+
packageJson.scripts = {};
|
|
82
|
+
packageJson.scripts.prepublish =
|
|
83
|
+
"npm run build:ldo && npm run generate-readme";
|
|
84
|
+
packageJson.scripts["generate-readme"] = `ldo generate-readme --project ./ --shapes ./.shapes --ldo ./.ldo`;
|
|
85
|
+
return packageJson;
|
|
86
|
+
});
|
|
87
|
+
load.text = "Generating README";
|
|
88
|
+
await (0, generateReadme_1.generateReadme)({
|
|
89
|
+
project: directory,
|
|
90
|
+
shapes: path_1.default.join(directory, ".shapes"),
|
|
91
|
+
ldo: path_1.default.join(directory, ".ldo"),
|
|
92
|
+
});
|
|
93
|
+
load.text = "Create .gitignore";
|
|
94
|
+
await fs_1.promises.writeFile(path_1.default.join(directory, ".gitignore"), "node_modules");
|
|
95
|
+
load.stop();
|
|
96
|
+
}
|
|
97
|
+
exports.create = create;
|
|
98
|
+
//# sourceMappingURL=create.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create.js","sourceRoot":"","sources":["../src/create.ts"],"names":[],"mappings":";;;;;;AAAA,iCAA8B;AAC9B,gEAA8E;AAC9E,qDAAkD;AAClD,gDAAwB;AACxB,sDAA8B;AAE9B,8DAAkC;AAClC,2BAAoC;AAG7B,KAAK,UAAU,MAAM,CAAC,SAAiB;IAE5C,MAAM,SAAS,GAAG,MAAM,IAAA,iBAAO,EAAC;QAC9B;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,eAAe;YACxB,OAAO,EAAE,cAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;SAClC;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,UAAU;YACnB,OAAO,EAAE,OAAO;SACjB;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,aAAa;YACnB,OAAO,EAAE,cAAc;SACxB;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE,6BAA6B;YACtC,SAAS,EAAE,GAAG;SACf;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,SAAS;SACnB;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,UAAU;YACnB,OAAO,EAAE,KAAK;SACf;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,YAAY;YAClB,OAAO,EAAE,4BAA4B;SACtC;KACF,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,IAAA,qBAAO,EAAC,yBAAyB,CAAC,CAAC;IAEhD,MAAM,WAAW,GAAgB;QAC/B,IAAI,EAAE,SAAS,CAAC,IAAI;QACpB,OAAO,EAAE,SAAS,CAAC,OAAO;QAC1B,WAAW,EAAE,SAAS,CAAC,WAAW;QAClC,QAAQ,EAAE,SAAS,CAAC,QAAQ;QAC5B,MAAM,EAAE,SAAS,CAAC,MAAM;QACxB,OAAO,EAAE,SAAS,CAAC,OAAO;QAC1B,IAAI,EAAE,YAAY;KACnB,CAAC;IAEF,IAAI,SAAS,CAAC,UAAU,EAAE;QACxB,WAAW,CAAC,UAAU,GAAG;YACvB,IAAI,EAAE,KAAK;YACX,GAAG,EAAE,SAAS,CAAC,UAAU;SAC1B,CAAC;QACF,WAAW,CAAC,IAAI,GAAG;YACjB,GAAG,EAAE,GAAG,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,SAAS;SAC5D,CAAC;QACF,WAAW,CAAC,QAAQ,GAAG,GAAG,SAAS,CAAC,UAAU,CAAC,OAAO,CACpD,QAAQ,EACR,EAAE,CACH,SAAS,CAAC;KACZ;IAED,MAAM,IAAA,mCAAe,EAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IAG9C,IAAI,CAAC,IAAI,GAAG,kBAAkB,CAAC;IAC/B,MAAM,IAAA,WAAI,EAAC,SAAS,CAAC,CAAC;IAGtB,MAAM,IAAA,qCAAiB,EAAC,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE;QACvD,IAAI,CAAC,WAAW,CAAC,OAAO;YAAE,WAAW,CAAC,OAAO,GAAG,EAAE,CAAC;QACnD,WAAW,CAAC,OAAO,CAAC,UAAU;YAC5B,8CAA8C,CAAC;QACjD,WAAW,CAAC,OAAO,CACjB,iBAAiB,CAClB,GAAG,kEAAkE,CAAC;QACvE,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC,CAAC;IAGH,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IAChC,MAAM,IAAA,+BAAc,EAAC;QACnB,OAAO,EAAE,SAAS;QAClB,MAAM,EAAE,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC;QACvC,GAAG,EAAE,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,CAAC;KAClC,CAAC,CAAC;IAGH,IAAI,CAAC,IAAI,GAAG,mBAAmB,CAAC;IAChC,MAAM,aAAE,CAAC,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,EAAE,cAAc,CAAC,CAAC;IAEvE,IAAI,CAAC,IAAI,EAAE,CAAC;AACd,CAAC;AApGD,wBAoGC"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
interface GenerateReadmeOptions {
|
|
2
|
+
project: string;
|
|
3
|
+
shapes: string;
|
|
4
|
+
ldo: string;
|
|
5
|
+
}
|
|
6
|
+
export declare function generateReadme(options: GenerateReadmeOptions): Promise<void>;
|
|
7
|
+
interface GenerateIndexOptions {
|
|
8
|
+
project: string;
|
|
9
|
+
}
|
|
10
|
+
export declare function generateIndex(options: GenerateIndexOptions): Promise<void>;
|
|
11
|
+
export {};
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.generateIndex = exports.generateReadme = void 0;
|
|
7
|
+
const modifyPackageJson_1 = require("./util/modifyPackageJson");
|
|
8
|
+
const forAllShapes_1 = require("./util/forAllShapes");
|
|
9
|
+
const fs_1 = require("fs");
|
|
10
|
+
const path_1 = __importDefault(require("path"));
|
|
11
|
+
const ts_morph_1 = require("ts-morph");
|
|
12
|
+
const ejs_1 = require("ejs");
|
|
13
|
+
async function generateReadme(options) {
|
|
14
|
+
const packageJson = await (0, modifyPackageJson_1.getPackageJson)(options.project);
|
|
15
|
+
const projectName = packageJson.name;
|
|
16
|
+
const projectDescription = packageJson.description;
|
|
17
|
+
const shapes = [];
|
|
18
|
+
await (0, forAllShapes_1.forAllShapes)(options.shapes, async (fileName, shexC) => {
|
|
19
|
+
const typeFilePath = path_1.default.join(options.ldo, `${fileName}.typings.ts`);
|
|
20
|
+
const typesRaw = await fs_1.promises.readFile(typeFilePath, "utf8");
|
|
21
|
+
const shape = {
|
|
22
|
+
name: fileName,
|
|
23
|
+
shex: shexC,
|
|
24
|
+
typescript: typesRaw,
|
|
25
|
+
types: [],
|
|
26
|
+
};
|
|
27
|
+
listInterfaces(typeFilePath).forEach((interfaceName) => {
|
|
28
|
+
shape.types.push({
|
|
29
|
+
typeName: interfaceName,
|
|
30
|
+
shapeTypeName: `${interfaceName}ShapeType`,
|
|
31
|
+
});
|
|
32
|
+
});
|
|
33
|
+
shapes.push(shape);
|
|
34
|
+
});
|
|
35
|
+
const readmeEjsOptions = {
|
|
36
|
+
projectName,
|
|
37
|
+
projectDescription,
|
|
38
|
+
shapes,
|
|
39
|
+
};
|
|
40
|
+
const finalContent = await (0, ejs_1.renderFile)(path_1.default.join(__dirname, "./templates/readme/", "main.ejs"), readmeEjsOptions);
|
|
41
|
+
await fs_1.promises.writeFile(path_1.default.join(options.project, "README.md"), finalContent);
|
|
42
|
+
await generateIndex({ project: options.project });
|
|
43
|
+
}
|
|
44
|
+
exports.generateReadme = generateReadme;
|
|
45
|
+
function listInterfaces(filePath) {
|
|
46
|
+
const project = new ts_morph_1.Project();
|
|
47
|
+
const sourceFile = project.addSourceFileAtPath(filePath);
|
|
48
|
+
const interfaces = sourceFile.getInterfaces().map((iface) => iface.getName());
|
|
49
|
+
return interfaces;
|
|
50
|
+
}
|
|
51
|
+
async function generateIndex(options) {
|
|
52
|
+
const ldoDir = await fs_1.promises.readdir(path_1.default.join(options.project, "./.ldo"), {
|
|
53
|
+
withFileTypes: true,
|
|
54
|
+
});
|
|
55
|
+
const indexText = await (0, ejs_1.renderFile)(path_1.default.join(__dirname, "./templates/readme/projectIndex.ejs"), { fileNames: ldoDir.map((file) => file.name) });
|
|
56
|
+
await fs_1.promises.writeFile(path_1.default.join(options.project, "index.js"), indexText);
|
|
57
|
+
}
|
|
58
|
+
exports.generateIndex = generateIndex;
|
|
59
|
+
//# sourceMappingURL=generateReadme.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generateReadme.js","sourceRoot":"","sources":["../src/generateReadme.ts"],"names":[],"mappings":";;;;;;AAAA,gEAA0D;AAC1D,sDAAmD;AACnD,2BAAoC;AACpC,gDAAwB;AACxB,uCAAmC;AACnC,6BAAiC;AAsB1B,KAAK,UAAU,cAAc,CAAC,OAA8B;IACjE,MAAM,WAAW,GAAG,MAAM,IAAA,kCAAc,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC1D,MAAM,WAAW,GAAG,WAAW,CAAC,IAAK,CAAC;IACtC,MAAM,kBAAkB,GAAG,WAAW,CAAC,WAAY,CAAC;IACpD,MAAM,MAAM,GAA+B,EAAE,CAAC;IAE9C,MAAM,IAAA,2BAAY,EAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE;QAC3D,MAAM,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,QAAQ,aAAa,CAAC,CAAC;QAEtE,MAAM,QAAQ,GAAG,MAAM,aAAE,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAEzD,MAAM,KAAK,GAAkC;YAC3C,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,KAAK;YACX,UAAU,EAAE,QAAQ;YACpB,KAAK,EAAE,EAAE;SACV,CAAC;QAEF,cAAc,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;YACrD,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;gBACf,QAAQ,EAAE,aAAa;gBACvB,aAAa,EAAE,GAAG,aAAa,WAAW;aAC3C,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAqB;QACzC,WAAW;QACX,kBAAkB;QAClB,MAAM;KACP,CAAC;IAGF,MAAM,YAAY,GAAG,MAAM,IAAA,gBAAU,EACnC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,qBAAqB,EAAE,UAAU,CAAC,EACvD,gBAAgB,CACjB,CAAC;IAEF,MAAM,aAAE,CAAC,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,WAAW,CAAC,EAAE,YAAY,CAAC,CAAC;IAE1E,MAAM,aAAa,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;AACpD,CAAC;AA3CD,wCA2CC;AAKD,SAAS,cAAc,CAAC,QAAgB;IACtC,MAAM,OAAO,GAAG,IAAI,kBAAO,EAAE,CAAC;IAC9B,MAAM,UAAU,GAAG,OAAO,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;IAGzD,MAAM,UAAU,GAAG,UAAU,CAAC,aAAa,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IAC9E,OAAO,UAAU,CAAC;AACpB,CAAC;AASM,KAAK,UAAU,aAAa,CAAC,OAA6B;IAC/D,MAAM,MAAM,GAAG,MAAM,aAAE,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE;QACpE,aAAa,EAAE,IAAI;KACpB,CAAC,CAAC;IACH,MAAM,SAAS,GAAG,MAAM,IAAA,gBAAU,EAChC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,qCAAqC,CAAC,EAC3D,EAAE,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC/C,CAAC;IACF,MAAM,aAAE,CAAC,SAAS,CAAC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,SAAS,CAAC,CAAC;AACxE,CAAC;AATD,sCASC"}
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
"use strict";
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
const commander_1 = require("commander");
|
|
5
|
+
const build_1 = require("./build");
|
|
6
|
+
const init_1 = require("./init");
|
|
7
|
+
const create_1 = require("./create");
|
|
8
|
+
const generateReadme_1 = require("./generateReadme");
|
|
9
|
+
commander_1.program
|
|
10
|
+
.name("LDO-CLI")
|
|
11
|
+
.description("CLI to some JavaScript string utilities")
|
|
12
|
+
.version("3.0.1");
|
|
13
|
+
commander_1.program
|
|
14
|
+
.command("build")
|
|
15
|
+
.description("Build contents of a shex folder into Shape Types")
|
|
16
|
+
.option("-i, --input <inputPath>", "Provide the input path", "./.shapes")
|
|
17
|
+
.option("-o, --output <outputPath>", "Provide the output path", "./.ldo")
|
|
18
|
+
.action(build_1.build);
|
|
19
|
+
commander_1.program
|
|
20
|
+
.command("init")
|
|
21
|
+
.argument("[directory]", "A parent directory for ldo files")
|
|
22
|
+
.description("Initializes a project for LDO.")
|
|
23
|
+
.action(init_1.init);
|
|
24
|
+
commander_1.program
|
|
25
|
+
.command("create")
|
|
26
|
+
.argument("<directory>", "The package's directory")
|
|
27
|
+
.description("Creates a standalone package for shapes to publish to NPM.")
|
|
28
|
+
.action(create_1.create);
|
|
29
|
+
commander_1.program
|
|
30
|
+
.command("generate-readme")
|
|
31
|
+
.description("Create a ReadMe from the shapes and generated code.")
|
|
32
|
+
.requiredOption("-p, --project <projectPath>", "Provide the path to the root project", "./")
|
|
33
|
+
.requiredOption("-s, --shapes <shapesPath>", "Provide the path to the shapes folder", "./.shapes")
|
|
34
|
+
.requiredOption("-s, --ldo <ldoPath>", "Provide the path to the ldo folder", "./.ldo")
|
|
35
|
+
.action(generateReadme_1.generateReadme);
|
|
36
|
+
commander_1.program.parse();
|
|
37
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,yCAAoC;AACpC,mCAAgC;AAChC,iCAA8B;AAC9B,qCAAkC;AAClC,qDAAkD;AAElD,mBAAO;KACJ,IAAI,CAAC,SAAS,CAAC;KACf,WAAW,CAAC,yCAAyC,CAAC;KACtD,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,mBAAO;KACJ,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,kDAAkD,CAAC;KAC/D,MAAM,CAAC,yBAAyB,EAAE,wBAAwB,EAAE,WAAW,CAAC;KACxE,MAAM,CAAC,2BAA2B,EAAE,yBAAyB,EAAE,QAAQ,CAAC;KACxE,MAAM,CAAC,aAAK,CAAC,CAAC;AAEjB,mBAAO;KACJ,OAAO,CAAC,MAAM,CAAC;KACf,QAAQ,CAAC,aAAa,EAAE,kCAAkC,CAAC;KAC3D,WAAW,CAAC,gCAAgC,CAAC;KAC7C,MAAM,CAAC,WAAI,CAAC,CAAC;AAEhB,mBAAO;KACJ,OAAO,CAAC,QAAQ,CAAC;KACjB,QAAQ,CAAC,aAAa,EAAE,yBAAyB,CAAC;KAClD,WAAW,CAAC,4DAA4D,CAAC;KACzE,MAAM,CAAC,eAAM,CAAC,CAAC;AAElB,mBAAO;KACJ,OAAO,CAAC,iBAAiB,CAAC;KAC1B,WAAW,CAAC,qDAAqD,CAAC;KAClE,cAAc,CACb,6BAA6B,EAC7B,sCAAsC,EACtC,IAAI,CACL;KACA,cAAc,CACb,2BAA2B,EAC3B,uCAAuC,EACvC,WAAW,CACZ;KACA,cAAc,CACb,qBAAqB,EACrB,oCAAoC,EACpC,QAAQ,CACT;KACA,MAAM,CAAC,+BAAc,CAAC,CAAC;AAE1B,mBAAO,CAAC,KAAK,EAAE,CAAC"}
|
package/dist/init.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function init(directory?: string): Promise<void>;
|
package/dist/init.js
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.init = void 0;
|
|
7
|
+
const child_process_promise_1 = require("child-process-promise");
|
|
8
|
+
const fs_extra_1 = __importDefault(require("fs-extra"));
|
|
9
|
+
const path_1 = __importDefault(require("path"));
|
|
10
|
+
const ejs_1 = require("ejs");
|
|
11
|
+
const modifyPackageJson_1 = require("./util/modifyPackageJson");
|
|
12
|
+
const DEFAULT_SHAPES_FOLDER = "./.shapes";
|
|
13
|
+
const DEFAULT_LDO_FOLDER = "./.ldo";
|
|
14
|
+
const POTENTIAL_PARENT_DIRECTORIES = ["src", "lib", "bin"];
|
|
15
|
+
async function init(directory) {
|
|
16
|
+
let parentDirectory = directory;
|
|
17
|
+
if (!parentDirectory) {
|
|
18
|
+
parentDirectory = "./";
|
|
19
|
+
const allDirectories = (await fs_extra_1.default.promises.readdir("./", {
|
|
20
|
+
withFileTypes: true,
|
|
21
|
+
})).filter((file) => file.isDirectory());
|
|
22
|
+
for (let i = 0; i < POTENTIAL_PARENT_DIRECTORIES.length; i++) {
|
|
23
|
+
if (allDirectories.some((dir) => dir.name === POTENTIAL_PARENT_DIRECTORIES[i])) {
|
|
24
|
+
parentDirectory = POTENTIAL_PARENT_DIRECTORIES[i];
|
|
25
|
+
break;
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
await (0, child_process_promise_1.exec)(`cd ${parentDirectory} && npm install @ldo/ldo --save`);
|
|
30
|
+
await (0, child_process_promise_1.exec)(`cd ${parentDirectory} && npm install @ldo/cli @types/shexj @types/jsonld --save-dev`);
|
|
31
|
+
const shapesFolderPath = path_1.default.join(parentDirectory, DEFAULT_SHAPES_FOLDER);
|
|
32
|
+
await fs_extra_1.default.promises.mkdir(shapesFolderPath);
|
|
33
|
+
const defaultShapePaths = await fs_extra_1.default.promises.readdir(path_1.default.join(__dirname, "./templates/defaultShapes"));
|
|
34
|
+
await Promise.all(defaultShapePaths.map(async (shapePath) => {
|
|
35
|
+
const shapeContent = await (0, ejs_1.renderFile)(path_1.default.join(__dirname, "./templates/defaultShapes", shapePath), {});
|
|
36
|
+
await fs_extra_1.default.promises.writeFile(path_1.default.join(shapesFolderPath, `${path_1.default.parse(shapePath).name}.shex`), shapeContent);
|
|
37
|
+
}));
|
|
38
|
+
await (0, modifyPackageJson_1.modifyPackageJson)(parentDirectory, async (packageJson) => {
|
|
39
|
+
if (!packageJson.scripts) {
|
|
40
|
+
packageJson.scripts = {};
|
|
41
|
+
}
|
|
42
|
+
const ldoFolder = path_1.default.join(parentDirectory, DEFAULT_LDO_FOLDER);
|
|
43
|
+
packageJson.scripts["build:ldo"] = `ldo build --input ${path_1.default.relative(parentDirectory, shapesFolderPath)} --output ${path_1.default.relative(parentDirectory, ldoFolder)}`;
|
|
44
|
+
return packageJson;
|
|
45
|
+
});
|
|
46
|
+
await (0, child_process_promise_1.exec)(`cd ${parentDirectory} && npm run build:ldo`);
|
|
47
|
+
}
|
|
48
|
+
exports.init = init;
|
|
49
|
+
//# sourceMappingURL=init.js.map
|
package/dist/init.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":";;;;;;AAAA,iEAA6C;AAC7C,wDAA0B;AAC1B,gDAAwB;AACxB,6BAAiC;AACjC,gEAA6D;AAE7D,MAAM,qBAAqB,GAAG,WAAW,CAAC;AAC1C,MAAM,kBAAkB,GAAG,QAAQ,CAAC;AACpC,MAAM,4BAA4B,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAEpD,KAAK,UAAU,IAAI,CAAC,SAAkB;IAE3C,IAAI,eAAe,GAAG,SAAU,CAAC;IACjC,IAAI,CAAC,eAAe,EAAE;QACpB,eAAe,GAAG,IAAI,CAAC;QACvB,MAAM,cAAc,GAAG,CACrB,MAAM,kBAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE;YAC9B,aAAa,EAAE,IAAI;SACpB,CAAC,CACH,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,4BAA4B,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC5D,IACE,cAAc,CAAC,IAAI,CACjB,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,4BAA4B,CAAC,CAAC,CAAC,CACtD,EACD;gBACA,eAAe,GAAG,4BAA4B,CAAC,CAAC,CAAC,CAAC;gBAClD,MAAM;aACP;SACF;KACF;IAGD,MAAM,IAAA,4BAAI,EAAC,MAAM,eAAe,iCAAiC,CAAC,CAAC;IACnE,MAAM,IAAA,4BAAI,EACR,MAAM,eAAe,gEAAgE,CACtF,CAAC;IAGF,MAAM,gBAAgB,GAAG,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,qBAAqB,CAAC,CAAC;IAC3E,MAAM,kBAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAC1C,MAAM,iBAAiB,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,OAAO,CACjD,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,2BAA2B,CAAC,CAClD,CAAC;IACF,MAAM,OAAO,CAAC,GAAG,CACf,iBAAiB,CAAC,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACxC,MAAM,YAAY,GAAG,MAAM,IAAA,gBAAU,EACnC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,2BAA2B,EAAE,SAAS,CAAC,EAC5D,EAAE,CACH,CAAC;QACF,MAAM,kBAAE,CAAC,QAAQ,CAAC,SAAS,CACzB,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,GAAG,cAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,OAAO,CAAC,EACjE,YAAY,CACb,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;IAGF,MAAM,IAAA,qCAAiB,EAAC,eAAe,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE;QAC7D,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE;YACxB,WAAW,CAAC,OAAO,GAAG,EAAE,CAAC;SAC1B;QACD,MAAM,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC;QACjE,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,qBAAqB,cAAI,CAAC,QAAQ,CACnE,eAAe,EACf,gBAAgB,CACjB,aAAa,cAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,EAAE,CAAC;QAC1D,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC,CAAC;IAGH,MAAM,IAAA,4BAAI,EAAC,MAAM,eAAe,uBAAuB,CAAC,CAAC;AAC3D,CAAC;AA9DD,oBA8DC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { LdoJsonldContext } from "@ldo/ldo";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* =============================================================================
|
|
5
|
+
* <%- fileName %>Context: JSONLD Context for <%- fileName %>
|
|
6
|
+
* =============================================================================
|
|
7
|
+
*/
|
|
8
|
+
export const <%- fileName %>Context: LdoJsonldContext = <%- context %>;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# This shape is provided by default as an example
|
|
2
|
+
# You can create your own shape to fit your needs using ShEx (https://shex.io)
|
|
3
|
+
# Also check out https://shaperepo.com for examples of more shapes.
|
|
4
|
+
|
|
5
|
+
PREFIX ex: <https://example.com/>
|
|
6
|
+
PREFIX foaf: <http://xmlns.com/foaf/0.1/>
|
|
7
|
+
PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
|
|
8
|
+
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>
|
|
9
|
+
|
|
10
|
+
ex:FoafProfile EXTRA a {
|
|
11
|
+
a [ foaf:Person ]
|
|
12
|
+
// rdfs:comment "Defines the node as a Person (from foaf)" ;
|
|
13
|
+
foaf:name xsd:string ?
|
|
14
|
+
// rdfs:comment "Define a person's name." ;
|
|
15
|
+
foaf:img xsd:string ?
|
|
16
|
+
// rdfs:comment "Photo link but in string form" ;
|
|
17
|
+
foaf:knows @ex:FoafProfile *
|
|
18
|
+
// rdfs:comment "A list of WebIds for all the people this user knows." ;
|
|
19
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# <%= projectName %>
|
|
2
|
+
|
|
3
|
+
<%- projectDescription %>
|
|
4
|
+
|
|
5
|
+
This project includes shapes and generated files for [LDO](https://ldo.js.org).
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm i <%= projectName %>
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
<% shapes.forEach(function(shape) { %>
|
|
14
|
+
<%- include('shape', { shape: shape, projectName: projectName }) %>
|
|
15
|
+
<% }); %>
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
## <%= shape.name %>
|
|
2
|
+
|
|
3
|
+
### Usage with LDO
|
|
4
|
+
|
|
5
|
+
```typescript
|
|
6
|
+
import { createLdoDataset } from "@ldo/ldo";
|
|
7
|
+
import { <%= shape.types.map((type) => type.shapeTypeName).join(", ") %> } from "<%= projectName %>";
|
|
8
|
+
import type { <%= shape.types.map((type) => type.typeName).join(", ") %> } from "<%= projectName %>";
|
|
9
|
+
const ldoDataset = createLdoDataset();
|
|
10
|
+
<% shape.types.forEach(function(type, index) { %>
|
|
11
|
+
const example<%= index %>: <%= type.typeName %> = ldoDataset
|
|
12
|
+
.usingType(<%= type.shapeTypeName %>)
|
|
13
|
+
.fromSubject("http://example.com/example<%= index %>");
|
|
14
|
+
<% }); %>
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### ShEx Typings
|
|
18
|
+
|
|
19
|
+
```shex
|
|
20
|
+
<%- shape.shex %>
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### TypeScript Typings
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
<%- shape.typescript %>
|
|
27
|
+
```
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { Schema } from "shexj";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* =============================================================================
|
|
5
|
+
* <%- fileName %>Schema: ShexJ Schema for <%- fileName %>
|
|
6
|
+
* =============================================================================
|
|
7
|
+
*/
|
|
8
|
+
export const <%- fileName %>Schema: Schema = <%- schema %>;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { ShapeType } from "@ldo/ldo";
|
|
2
|
+
import { <%- fileName %>Schema } from "./<%- fileName %>.schema";
|
|
3
|
+
import { <%- fileName %>Context } from "./<%- fileName %>.context";
|
|
4
|
+
import {
|
|
5
|
+
<% typings.forEach((typing) => { -%>
|
|
6
|
+
<%- typing.dts.name %>,
|
|
7
|
+
<% }); -%>} from "./<%- fileName %>.typings";
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* =============================================================================
|
|
11
|
+
* LDO ShapeTypes <%- fileName %>
|
|
12
|
+
* =============================================================================
|
|
13
|
+
*/
|
|
14
|
+
<% typings.forEach((typing) => { -%>
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* <%- typing.dts.name %> ShapeType
|
|
18
|
+
*/
|
|
19
|
+
export const <%- typing.dts.name %>ShapeType: ShapeType<<%- typing.dts.name %>> = {
|
|
20
|
+
schema: <%- fileName %>Schema,
|
|
21
|
+
shape: "<%- typing.dts.shapeId %>",
|
|
22
|
+
context: <%- fileName %>Context,
|
|
23
|
+
};
|
|
24
|
+
<% }); -%>
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { LdoJsonldContext, LdSet } from "@ldo/ldo";
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* =============================================================================
|
|
5
|
+
* Typescript Typings for <%- fileName %>
|
|
6
|
+
* =============================================================================
|
|
7
|
+
*/
|
|
8
|
+
|
|
9
|
+
<% typings.forEach((typing) => { -%>
|
|
10
|
+
/**
|
|
11
|
+
* <%- typing.dts.name %> Type
|
|
12
|
+
*/
|
|
13
|
+
export <%- typing.typingString -%>
|
|
14
|
+
<% }); -%>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function forAllShapes(shapePath: string, callback: (filename: string, shape: string) => Promise<void>): Promise<void>;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.forAllShapes = void 0;
|
|
7
|
+
const fs_1 = __importDefault(require("fs"));
|
|
8
|
+
const path_1 = __importDefault(require("path"));
|
|
9
|
+
async function forAllShapes(shapePath, callback) {
|
|
10
|
+
const shapeDir = await fs_1.default.promises.readdir(shapePath, {
|
|
11
|
+
withFileTypes: true,
|
|
12
|
+
});
|
|
13
|
+
const shexFiles = shapeDir.filter((file) => file.isFile() && file.name.endsWith(".shex"));
|
|
14
|
+
await Promise.all(shexFiles.map(async (file) => {
|
|
15
|
+
const fileName = path_1.default.parse(file.name).name;
|
|
16
|
+
const shexC = await fs_1.default.promises.readFile(path_1.default.join(shapePath, file.name), "utf8");
|
|
17
|
+
await callback(fileName, shexC);
|
|
18
|
+
}));
|
|
19
|
+
}
|
|
20
|
+
exports.forAllShapes = forAllShapes;
|
|
21
|
+
//# sourceMappingURL=forAllShapes.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"forAllShapes.js","sourceRoot":"","sources":["../../src/util/forAllShapes.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAEjB,KAAK,UAAU,YAAY,CAChC,SAAiB,EACjB,QAA4D;IAE5D,MAAM,QAAQ,GAAG,MAAM,YAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,SAAS,EAAE;QACpD,aAAa,EAAE,IAAI;KACpB,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,QAAQ,CAAC,MAAM,CAC/B,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CACvD,CAAC;IACF,MAAM,OAAO,CAAC,GAAG,CACf,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAC3B,MAAM,QAAQ,GAAG,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC;QAE5C,MAAM,KAAK,GAAG,MAAM,YAAE,CAAC,QAAQ,CAAC,QAAQ,CACtC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,CAAC,EAC/B,MAAM,CACP,CAAC;QACF,MAAM,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAtBD,oCAsBC"}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { PackageJson } from "type-fest";
|
|
2
|
+
export declare function getPackageJson(projectFolder: string): Promise<PackageJson>;
|
|
3
|
+
export declare function savePackageJson(projectFolder: string, packageJson: PackageJson): Promise<void>;
|
|
4
|
+
export declare function modifyPackageJson(projectFolder: string, modifyCallback: (packageJson: PackageJson) => Promise<PackageJson>): Promise<void>;
|