@ldo/cli 0.0.1-alpha.26 → 0.0.1-alpha.29

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/README.md CHANGED
@@ -53,9 +53,20 @@ This will generate five files:
53
53
  - `./ldo/foafProfile.schema.ts`
54
54
  - `./ldo/foafProfile.context.ts`
55
55
 
56
+ ## Creating a new project to distribure shapes
57
+
58
+ 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.
59
+
60
+ ```bash
61
+ npx @ldo/cli create ./my-project
62
+ ```
63
+
64
+ 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.
65
+
56
66
  ## API Details
57
67
  - [`init` command](https://ldo.js.org/api/cli/init/)
58
68
  - [`build` command](https://ldo.js.org/api/cli/build/)
69
+ - [`create` command](https://ldo.js.org/api/cli/create/)
59
70
  ```
60
71
 
61
72
  ## Sponsorship
package/dist/build.js CHANGED
@@ -11,21 +11,16 @@ const schema_converter_shex_1 = __importDefault(require("@ldo/schema-converter-s
11
11
  const ejs_1 = require("ejs");
12
12
  const prettier_1 = __importDefault(require("prettier"));
13
13
  const loading_cli_1 = __importDefault(require("loading-cli"));
14
+ const forAllShapes_1 = require("./util/forAllShapes");
14
15
  async function build(options) {
15
16
  const load = (0, loading_cli_1.default)("Peparing Environment");
16
17
  load.start();
17
- const shapeDir = await fs_extra_1.default.promises.readdir(options.input, {
18
- withFileTypes: true,
19
- });
20
- const shexFiles = shapeDir.filter((file) => file.isFile() && file.name.endsWith(".shex"));
21
18
  if (fs_extra_1.default.existsSync(options.output)) {
22
19
  await fs_extra_1.default.promises.rm(options.output, { recursive: true });
23
20
  }
24
21
  await fs_extra_1.default.promises.mkdir(options.output);
25
22
  load.text = "Generating LDO Documents";
26
- await Promise.all(shexFiles.map(async (file) => {
27
- const fileName = path_1.default.parse(file.name).name;
28
- const shexC = await fs_extra_1.default.promises.readFile(path_1.default.join(options.input, file.name), "utf8");
23
+ await (0, forAllShapes_1.forAllShapes)(options.input, async (fileName, shexC) => {
29
24
  let schema;
30
25
  try {
31
26
  schema = parser_1.default.construct("https://ldo.js.org/").parse(shexC);
@@ -36,7 +31,7 @@ async function build(options) {
36
31
  : typeof err === "string"
37
32
  ? err
38
33
  : "Unknown Error";
39
- console.error(`Error processing ${file.name}: ${errMessage}`);
34
+ console.error(`Error processing ${fileName}: ${errMessage}`);
40
35
  return;
41
36
  }
42
37
  const [typings, context] = await (0, schema_converter_shex_1.default)(schema);
@@ -49,7 +44,7 @@ async function build(options) {
49
44
  });
50
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" }));
51
46
  }));
52
- }));
47
+ });
53
48
  load.stop();
54
49
  }
55
50
  exports.build = build;
package/dist/build.js.map CHANGED
@@ -1 +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;AAO3B,KAAK,UAAU,KAAK,CAAC,OAAqB;IAC/C,MAAM,IAAI,GAAG,IAAA,qBAAO,EAAC,sBAAsB,CAAC,CAAC;IAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;IACb,MAAM,QAAQ,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE;QACxD,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;IAEF,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,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,kBAAE,CAAC,QAAQ,CAAC,QAAQ,CACtC,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,EACnC,MAAM,CACP,CAAC;QAEF,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,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC,CAAC;YAC9D,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,CACH,CAAC;IACF,IAAI,CAAC,IAAI,EAAE,CAAC;AACd,CAAC;AAhED,sBAgEC"}
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"}
@@ -0,0 +1 @@
1
+ export declare function create(directory: string): Promise<void>;
package/dist/create.js ADDED
@@ -0,0 +1,103 @@
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
+ const ejs_1 = require("ejs");
15
+ async function create(directory) {
16
+ const responses = await (0, prompts_1.default)([
17
+ {
18
+ type: "text",
19
+ name: "name",
20
+ message: "Package name:",
21
+ initial: path_1.default.basename(directory),
22
+ },
23
+ {
24
+ type: "text",
25
+ name: "version",
26
+ message: "Version:",
27
+ initial: "1.0.0",
28
+ },
29
+ {
30
+ type: "text",
31
+ name: "description",
32
+ message: "Description:",
33
+ },
34
+ {
35
+ type: "list",
36
+ name: "keywords",
37
+ message: "Keywords (comma separated):",
38
+ separator: ",",
39
+ },
40
+ {
41
+ type: "text",
42
+ name: "author",
43
+ message: "Author:",
44
+ },
45
+ {
46
+ type: "text",
47
+ name: "license",
48
+ message: "License:",
49
+ initial: "MIT",
50
+ },
51
+ {
52
+ type: "text",
53
+ name: "repository",
54
+ message: "Git repository (optional):",
55
+ },
56
+ ]);
57
+ const load = (0, loading_cli_1.default)("Generating package.json");
58
+ const packageJson = {
59
+ name: responses.name,
60
+ version: responses.version,
61
+ description: responses.description,
62
+ keywords: responses.keywords,
63
+ author: responses.author,
64
+ license: responses.license,
65
+ main: "./index.js",
66
+ };
67
+ if (responses.repository) {
68
+ packageJson.repository = {
69
+ type: "git",
70
+ url: responses.repository,
71
+ };
72
+ packageJson.bugs = {
73
+ url: `${responses.repository.replace(/\.git$/, "")}/issues`,
74
+ };
75
+ packageJson.homepage = `${responses.repository.replace(/\.git$/, "")}#readme`;
76
+ }
77
+ await (0, modifyPackageJson_1.savePackageJson)(directory, packageJson);
78
+ load.text = "Initializing LDO";
79
+ await (0, init_1.init)(directory);
80
+ await (0, modifyPackageJson_1.modifyPackageJson)(directory, async (packageJson) => {
81
+ if (!packageJson.scripts)
82
+ packageJson.scripts = {};
83
+ packageJson.scripts.prepublish =
84
+ "npm run build:ldo & npm run generate-readme";
85
+ packageJson.scripts["genenerate-readme"] = `ldo generate-readme --project ./ --shapes ./.shapes --ldo ./.ldo`;
86
+ return packageJson;
87
+ });
88
+ load.text = "Generating index.js";
89
+ const ldoDir = await fs_1.promises.readdir(path_1.default.join(directory, "./.ldo"), {
90
+ withFileTypes: true,
91
+ });
92
+ const indexText = await (0, ejs_1.renderFile)(path_1.default.join(__dirname, "./templates/readme/projectIndex.ejs"), { fileNames: ldoDir.map((file) => file.name) });
93
+ await fs_1.promises.writeFile(path_1.default.join(directory, "index.js"), indexText);
94
+ load.text = "Generating README";
95
+ await (0, generateReadme_1.generateReadme)({
96
+ project: directory,
97
+ shapes: path_1.default.join(directory, ".shapes"),
98
+ ldo: path_1.default.join(directory, ".ldo"),
99
+ });
100
+ load.stop();
101
+ }
102
+ exports.create = create;
103
+ //# 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;AACpC,6BAAiC;AAE1B,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,6CAA6C,CAAC;QAChD,WAAW,CAAC,OAAO,CACjB,mBAAmB,CACpB,GAAG,kEAAkE,CAAC;QACvE,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC,CAAC;IAGH,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IAClC,MAAM,MAAM,GAAG,MAAM,aAAE,CAAC,OAAO,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE;QAC9D,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,SAAS,EAAE,UAAU,CAAC,EAAE,SAAS,CAAC,CAAC;IAGhE,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;IAEH,IAAI,CAAC,IAAI,EAAE,CAAC;AACd,CAAC;AA3GD,wBA2GC"}
@@ -0,0 +1,7 @@
1
+ interface GenerateReadmeOptions {
2
+ project: string;
3
+ shapes: string;
4
+ ldo: string;
5
+ }
6
+ export declare function generateReadme(options: GenerateReadmeOptions): Promise<void>;
7
+ export {};
@@ -0,0 +1,50 @@
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.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
+ }
43
+ exports.generateReadme = generateReadme;
44
+ function listInterfaces(filePath) {
45
+ const project = new ts_morph_1.Project();
46
+ const sourceFile = project.addSourceFileAtPath(filePath);
47
+ const interfaces = sourceFile.getInterfaces().map((iface) => iface.getName());
48
+ return interfaces;
49
+ }
50
+ //# 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;AAC5E,CAAC;AAzCD,wCAyCC;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"}
package/dist/index.js CHANGED
@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
4
4
  const commander_1 = require("commander");
5
5
  const build_1 = require("./build");
6
6
  const init_1 = require("./init");
7
+ const create_1 = require("./create");
7
8
  commander_1.program
8
9
  .name("LDO-CLI")
9
10
  .description("CLI to some JavaScript string utilities")
@@ -16,8 +17,20 @@ commander_1.program
16
17
  .action(build_1.build);
17
18
  commander_1.program
18
19
  .command("init")
19
- .option("-d --directory>", "A parent directory for ldo files")
20
+ .argument("[directory]", "A parent directory for ldo files")
20
21
  .description("Initializes a project for LDO.")
21
22
  .action(init_1.init);
23
+ commander_1.program
24
+ .command("create")
25
+ .argument("<directory>", "The package's directory")
26
+ .description("Creates a standalone package for shapes to publish to NPM.")
27
+ .action(create_1.create);
28
+ commander_1.program
29
+ .command("generate-readme")
30
+ .description("Create a ReadMe from the shapes and generated code.")
31
+ .requiredOption("-r, --readme <readmePath>", "Provide the path to the readme", "./.shapes")
32
+ .requiredOption("-s, --shapes <shapesPath>", "Provide the path to the shapes folder", "./.shapes")
33
+ .requiredOption("-s, --ldo <ldoPath>", "Provide the path to the ldo folder", "./.ldo")
34
+ .action(build_1.build);
22
35
  commander_1.program.parse();
23
36
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,yCAAoC;AACpC,mCAAgC;AAChC,iCAA8B;AAE9B,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,MAAM,CAAC,iBAAiB,EAAE,kCAAkC,CAAC;KAC7D,WAAW,CAAC,gCAAgC,CAAC;KAC7C,MAAM,CAAC,WAAI,CAAC,CAAC;AAEhB,mBAAO,CAAC,KAAK,EAAE,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,yCAAoC;AACpC,mCAAgC;AAChC,iCAA8B;AAC9B,qCAAkC;AAElC,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,2BAA2B,EAC3B,gCAAgC,EAChC,WAAW,CACZ;KACA,cAAc,CACb,2BAA2B,EAC3B,uCAAuC,EACvC,WAAW,CACZ;KACA,cAAc,CACb,qBAAqB,EACrB,oCAAoC,EACpC,QAAQ,CACT;KACA,MAAM,CAAC,aAAK,CAAC,CAAC;AAEjB,mBAAO,CAAC,KAAK,EAAE,CAAC"}
package/dist/init.d.ts CHANGED
@@ -1,4 +1 @@
1
- export interface InitOptions {
2
- directory?: string;
3
- }
4
- export declare function init(initOptions: InitOptions): Promise<void>;
1
+ export declare function init(directory?: string): Promise<void>;
package/dist/init.js CHANGED
@@ -8,13 +8,12 @@ const child_process_promise_1 = require("child-process-promise");
8
8
  const fs_extra_1 = __importDefault(require("fs-extra"));
9
9
  const path_1 = __importDefault(require("path"));
10
10
  const ejs_1 = require("ejs");
11
+ const modifyPackageJson_1 = require("./util/modifyPackageJson");
11
12
  const DEFAULT_SHAPES_FOLDER = "./.shapes";
12
13
  const DEFAULT_LDO_FOLDER = "./.ldo";
13
14
  const POTENTIAL_PARENT_DIRECTORIES = ["src", "lib", "bin"];
14
- async function init(initOptions) {
15
- await (0, child_process_promise_1.exec)("npm install @ldo/ldo --save");
16
- await (0, child_process_promise_1.exec)("npm install @ldo/cli @types/shexj @types/jsonld --save-dev");
17
- let parentDirectory = initOptions.directory;
15
+ async function init(directory) {
16
+ let parentDirectory = directory;
18
17
  if (!parentDirectory) {
19
18
  parentDirectory = "./";
20
19
  const allDirectories = (await fs_extra_1.default.promises.readdir("./", {
@@ -27,6 +26,8 @@ async function init(initOptions) {
27
26
  }
28
27
  }
29
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`);
30
31
  const shapesFolderPath = path_1.default.join(parentDirectory, DEFAULT_SHAPES_FOLDER);
31
32
  await fs_extra_1.default.promises.mkdir(shapesFolderPath);
32
33
  const defaultShapePaths = await fs_extra_1.default.promises.readdir(path_1.default.join(__dirname, "./templates/defaultShapes"));
@@ -34,14 +35,15 @@ async function init(initOptions) {
34
35
  const shapeContent = await (0, ejs_1.renderFile)(path_1.default.join(__dirname, "./templates/defaultShapes", shapePath), {});
35
36
  await fs_extra_1.default.promises.writeFile(path_1.default.join(shapesFolderPath, `${path_1.default.parse(shapePath).name}.shex`), shapeContent);
36
37
  }));
37
- const packageJson = JSON.parse((await fs_extra_1.default.promises.readFile("./package.json")).toString());
38
- if (!packageJson.scripts) {
39
- packageJson.scripts = {};
40
- }
41
- const ldoFolder = path_1.default.join(parentDirectory, DEFAULT_LDO_FOLDER);
42
- packageJson.scripts["build:ldo"] = `ldo build --input ${shapesFolderPath} --output ${ldoFolder}`;
43
- await fs_extra_1.default.promises.writeFile("./package.json", JSON.stringify(packageJson, null, 2));
44
- await (0, child_process_promise_1.exec)("npm run build:ldo");
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`);
45
47
  }
46
48
  exports.init = init;
47
49
  //# sourceMappingURL=init.js.map
package/dist/init.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"init.js","sourceRoot":"","sources":["../src/init.ts"],"names":[],"mappings":";;;;;;AAAA,iEAA6C;AAC7C,wDAA0B;AAC1B,gDAAwB;AACxB,6BAAiC;AAEjC,MAAM,qBAAqB,GAAG,WAAW,CAAC;AAC1C,MAAM,kBAAkB,GAAG,QAAQ,CAAC;AACpC,MAAM,4BAA4B,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAMpD,KAAK,UAAU,IAAI,CAAC,WAAwB;IAEjD,MAAM,IAAA,4BAAI,EAAC,6BAA6B,CAAC,CAAC;IAC1C,MAAM,IAAA,4BAAI,EAAC,4DAA4D,CAAC,CAAC;IAGzE,IAAI,eAAe,GAAG,WAAW,CAAC,SAAS,CAAC;IAC5C,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,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;IAIF,MAAM,WAAW,GAAQ,IAAI,CAAC,KAAK,CACjC,CAAC,MAAM,kBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,CAAC,QAAQ,EAAE,CAC1D,CAAC;IACF,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE;QACxB,WAAW,CAAC,OAAO,GAAG,EAAE,CAAC;KAC1B;IACD,MAAM,SAAS,GAAG,cAAI,CAAC,IAAI,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAAC;IACjE,WAAW,CAAC,OAAO,CACjB,WAAW,CACZ,GAAG,qBAAqB,gBAAgB,aAAa,SAAS,EAAE,CAAC;IAClE,MAAM,kBAAE,CAAC,QAAQ,CAAC,SAAS,CACzB,gBAAgB,EAChB,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CACrC,CAAC;IAGF,MAAM,IAAA,4BAAI,EAAC,mBAAmB,CAAC,CAAC;AAClC,CAAC;AAhED,oBAgEC"}
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"}
@@ -1,8 +1,8 @@
1
- import { ContextDefinition } from "jsonld";
1
+ import { LdoJsonldContext } from "@ldo/jsonld-dataset-proxy";
2
2
 
3
3
  /**
4
4
  * =============================================================================
5
5
  * <%- fileName %>Context: JSONLD Context for <%- fileName %>
6
6
  * =============================================================================
7
7
  */
8
- export const <%- fileName %>Context: ContextDefinition = <%- context %>;
8
+ export const <%- fileName %>Context: LdoJsonldContext = <%- context %>;
@@ -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,2 @@
1
+ <% fileNames.forEach((fileName) => { %>export * from "./.ldo/<%- fileName %>";
2
+ <% }); %>
@@ -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 @@
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>;
@@ -0,0 +1,24 @@
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.modifyPackageJson = exports.savePackageJson = exports.getPackageJson = void 0;
7
+ const fs_extra_1 = __importDefault(require("fs-extra"));
8
+ const path_1 = __importDefault(require("path"));
9
+ async function getPackageJson(projectFolder) {
10
+ return JSON.parse((await fs_extra_1.default.promises.readFile(path_1.default.join(projectFolder, "./package.json"))).toString());
11
+ }
12
+ exports.getPackageJson = getPackageJson;
13
+ async function savePackageJson(projectFolder, packageJson) {
14
+ await fs_extra_1.default.promises.mkdir(projectFolder, { recursive: true });
15
+ await fs_extra_1.default.promises.writeFile(path_1.default.join(projectFolder, "./package.json"), JSON.stringify(packageJson, null, 2));
16
+ }
17
+ exports.savePackageJson = savePackageJson;
18
+ async function modifyPackageJson(projectFolder, modifyCallback) {
19
+ const packageJson = await getPackageJson(projectFolder);
20
+ const newPackageJson = await modifyCallback(packageJson);
21
+ await savePackageJson(projectFolder, newPackageJson);
22
+ }
23
+ exports.modifyPackageJson = modifyPackageJson;
24
+ //# sourceMappingURL=modifyPackageJson.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"modifyPackageJson.js","sourceRoot":"","sources":["../../src/util/modifyPackageJson.ts"],"names":[],"mappings":";;;;;;AACA,wDAA0B;AAC1B,gDAAwB;AAEjB,KAAK,UAAU,cAAc,CAClC,aAAqB;IAErB,OAAO,IAAI,CAAC,KAAK,CACf,CACE,MAAM,kBAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,CACvE,CAAC,QAAQ,EAAE,CACb,CAAC;AACJ,CAAC;AARD,wCAQC;AAEM,KAAK,UAAU,eAAe,CACnC,aAAqB,EACrB,WAAwB;IAExB,MAAM,kBAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,MAAM,kBAAE,CAAC,QAAQ,CAAC,SAAS,CACzB,cAAI,CAAC,IAAI,CAAC,aAAa,EAAE,gBAAgB,CAAC,EAC1C,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CACrC,CAAC;AACJ,CAAC;AATD,0CASC;AAEM,KAAK,UAAU,iBAAiB,CACrC,aAAqB,EACrB,cAAkE;IAElE,MAAM,WAAW,GAAgB,MAAM,cAAc,CAAC,aAAa,CAAC,CAAC;IACrE,MAAM,cAAc,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,CAAC;IACzD,MAAM,eAAe,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;AACvD,CAAC;AAPD,8CAOC"}
package/package.json CHANGED
@@ -1,26 +1,22 @@
1
1
  {
2
2
  "name": "@ldo/cli",
3
- "version": "0.0.1-alpha.26",
3
+ "version": "0.0.1-alpha.29",
4
4
  "description": "A Command Line Interface for Linked Data Objects",
5
5
  "main": "./dist/index.js",
6
6
  "bin": {
7
7
  "ldo": "./dist/index.js"
8
8
  },
9
9
  "scripts": {
10
- "start": "node dist/index.js build",
11
- "start:init": "node dist/index.js init",
12
- "dev": "npm run build && npm run start:init",
13
- "build": "npm run clean && npm run build:ts && npm run copy-files",
10
+ "build": "npm run clean && npm run build:ts && npm run copy-files && npm run update-permission",
14
11
  "build:ts": "tsc --project tsconfig.build.json",
15
12
  "clean": "rimraf dist/",
16
13
  "copy-files": "copyfiles -u 1 \"./src/**/*.ejs\" dist/",
17
- "update-permission": "chmod +x ../../node_modules/.bin/ldo",
18
- "watch": "tsc --watch",
14
+ "update-permission": "chmod +x ./dist/index.js",
19
15
  "test": "jest --coverage",
20
- "test:watch": "jest --watch",
21
16
  "prepublishOnly": "npm run test && npm run build",
22
17
  "lint": "eslint src/** --fix --no-error-on-unmatched-pattern",
23
- "build:ldo": "./dist/index.js build --input test/.shapes --output test/.ldo"
18
+ "test:init": "rm -rf ./example-init && cp -R ./example-init-placeholder ./example-init && cd ./example-init && ../dist/index.js init",
19
+ "test:create": "rm -rf ./example-create && ./dist/index.js create ./example-create"
24
20
  },
25
21
  "repository": {
26
22
  "type": "git",
@@ -33,25 +29,32 @@
33
29
  },
34
30
  "homepage": "https://github.com/o-development/ldobjects/tree/main/packages/cli#readme",
35
31
  "devDependencies": {
32
+ "@ldo/cli": "^0.0.1-alpha.28",
36
33
  "@types/child-process-promise": "^2.2.2",
37
34
  "@types/ejs": "^3.1.1",
38
35
  "@types/fs-extra": "^9.0.13",
39
36
  "@types/jest": "^27.0.3",
40
- "@types/shexj": "2.1.4",
37
+ "@types/jsonld": "^1.5.15",
38
+ "@types/prompts": "^2.4.9",
39
+ "@types/shexj": "^2.1.4",
41
40
  "copyfiles": "^2.4.1",
42
41
  "jest": "^27.4.2",
43
42
  "rimraf": "^3.0.2",
44
43
  "ts-jest": "^27.0.7"
45
44
  },
46
45
  "dependencies": {
47
- "@ldo/schema-converter-shex": "^0.0.1-alpha.24",
46
+ "@ldo/ldo": "^0.0.1-alpha.29",
47
+ "@ldo/schema-converter-shex": "^0.0.1-alpha.29",
48
48
  "@shexjs/parser": "^1.0.0-alpha.24",
49
49
  "child-process-promise": "^2.2.1",
50
50
  "commander": "^9.3.0",
51
51
  "ejs": "^3.1.8",
52
52
  "fs-extra": "^10.1.0",
53
53
  "loading-cli": "^1.1.0",
54
- "prettier": "^3.0.3"
54
+ "prettier": "^3.0.3",
55
+ "prompts": "^2.4.2",
56
+ "ts-morph": "^24.0.0",
57
+ "type-fest": "^2.19.0"
55
58
  },
56
59
  "files": [
57
60
  "dist",
@@ -60,5 +63,5 @@
60
63
  "publishConfig": {
61
64
  "access": "public"
62
65
  },
63
- "gitHead": "598755bbfc0681ad05a7093844bf699bfbe1311f"
66
+ "gitHead": "56f78cef2b1b0d668c47d356c5f13517fe714505"
64
67
  }
package/src/build.ts CHANGED
@@ -6,6 +6,7 @@ import schemaConverterShex from "@ldo/schema-converter-shex";
6
6
  import { renderFile } from "ejs";
7
7
  import prettier from "prettier";
8
8
  import loading from "loading-cli";
9
+ import { forAllShapes } from "./util/forAllShapes";
9
10
 
10
11
  interface BuildOptions {
11
12
  input: string;
@@ -15,13 +16,6 @@ interface BuildOptions {
15
16
  export async function build(options: BuildOptions) {
16
17
  const load = loading("Peparing Environment");
17
18
  load.start();
18
- const shapeDir = await fs.promises.readdir(options.input, {
19
- withFileTypes: true,
20
- });
21
- // Filter out non-shex documents
22
- const shexFiles = shapeDir.filter(
23
- (file) => file.isFile() && file.name.endsWith(".shex"),
24
- );
25
19
  // Prepare new folder by clearing/and/or creating it
26
20
  if (fs.existsSync(options.output)) {
27
21
  await fs.promises.rm(options.output, { recursive: true });
@@ -29,51 +23,44 @@ export async function build(options: BuildOptions) {
29
23
  await fs.promises.mkdir(options.output);
30
24
 
31
25
  load.text = "Generating LDO Documents";
32
- await Promise.all(
33
- shexFiles.map(async (file) => {
34
- const fileName = path.parse(file.name).name;
35
- // Get the content of each document
36
- const shexC = await fs.promises.readFile(
37
- path.join(options.input, file.name),
38
- "utf8",
39
- );
40
- // Convert to ShexJ
41
- let schema: Schema;
42
- try {
43
- schema = parser.construct("https://ldo.js.org/").parse(shexC);
44
- } catch (err) {
45
- const errMessage =
46
- err instanceof Error
47
- ? err.message
48
- : typeof err === "string"
49
- ? err
50
- : "Unknown Error";
51
- console.error(`Error processing ${file.name}: ${errMessage}`);
52
- return;
53
- }
54
- // Convert the content to types
55
- const [typings, context] = await schemaConverterShex(schema);
56
- await Promise.all(
57
- ["context", "schema", "shapeTypes", "typings"].map(
58
- async (templateName) => {
59
- const finalContent = await renderFile(
60
- path.join(__dirname, "./templates", `${templateName}.ejs`),
61
- {
62
- typings: typings.typings,
63
- fileName,
64
- schema: JSON.stringify(schema, null, 2),
65
- context: JSON.stringify(context, null, 2),
66
- },
67
- );
68
- // Save conversion to document
69
- await fs.promises.writeFile(
70
- path.join(options.output, `${fileName}.${templateName}.ts`),
71
- await prettier.format(finalContent, { parser: "typescript" }),
72
- );
73
- },
74
- ),
75
- );
76
- }),
77
- );
26
+ await forAllShapes(options.input, async (fileName, shexC) => {
27
+ // Convert to ShexJ
28
+ let schema: Schema;
29
+ try {
30
+ schema = parser.construct("https://ldo.js.org/").parse(shexC);
31
+ } catch (err) {
32
+ const errMessage =
33
+ err instanceof Error
34
+ ? err.message
35
+ : typeof err === "string"
36
+ ? err
37
+ : "Unknown Error";
38
+ console.error(`Error processing ${fileName}: ${errMessage}`);
39
+ return;
40
+ }
41
+ // Convert the content to types
42
+ const [typings, context] = await schemaConverterShex(schema);
43
+ await Promise.all(
44
+ ["context", "schema", "shapeTypes", "typings"].map(
45
+ async (templateName) => {
46
+ const finalContent = await renderFile(
47
+ path.join(__dirname, "./templates", `${templateName}.ejs`),
48
+ {
49
+ typings: typings.typings,
50
+ fileName,
51
+ schema: JSON.stringify(schema, null, 2),
52
+ context: JSON.stringify(context, null, 2),
53
+ },
54
+ );
55
+ // Save conversion to document
56
+ await fs.promises.writeFile(
57
+ path.join(options.output, `${fileName}.${templateName}.ts`),
58
+ await prettier.format(finalContent, { parser: "typescript" }),
59
+ );
60
+ },
61
+ ),
62
+ );
63
+ });
64
+
78
65
  load.stop();
79
66
  }
package/src/create.ts ADDED
@@ -0,0 +1,118 @@
1
+ import { init } from "./init";
2
+ import { modifyPackageJson, savePackageJson } from "./util/modifyPackageJson";
3
+ import { generateReadme } from "./generateReadme";
4
+ import path from "path";
5
+ import prompts from "prompts";
6
+ import type { PackageJson } from "type-fest";
7
+ import loading from "loading-cli";
8
+ import { promises as fs } from "fs";
9
+ import { renderFile } from "ejs";
10
+
11
+ export async function create(directory: string) {
12
+ // Init the NPM Package
13
+ const responses = await prompts([
14
+ {
15
+ type: "text",
16
+ name: "name",
17
+ message: "Package name:",
18
+ initial: path.basename(directory),
19
+ },
20
+ {
21
+ type: "text",
22
+ name: "version",
23
+ message: "Version:",
24
+ initial: "1.0.0",
25
+ },
26
+ {
27
+ type: "text",
28
+ name: "description",
29
+ message: "Description:",
30
+ },
31
+ {
32
+ type: "list",
33
+ name: "keywords",
34
+ message: "Keywords (comma separated):",
35
+ separator: ",",
36
+ },
37
+ {
38
+ type: "text",
39
+ name: "author",
40
+ message: "Author:",
41
+ },
42
+ {
43
+ type: "text",
44
+ name: "license",
45
+ message: "License:",
46
+ initial: "MIT",
47
+ },
48
+ {
49
+ type: "text",
50
+ name: "repository",
51
+ message: "Git repository (optional):",
52
+ },
53
+ ]);
54
+
55
+ const load = loading("Generating package.json");
56
+
57
+ const packageJson: 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
+
67
+ if (responses.repository) {
68
+ packageJson.repository = {
69
+ type: "git",
70
+ url: responses.repository,
71
+ };
72
+ packageJson.bugs = {
73
+ url: `${responses.repository.replace(/\.git$/, "")}/issues`,
74
+ };
75
+ packageJson.homepage = `${responses.repository.replace(
76
+ /\.git$/,
77
+ "",
78
+ )}#readme`;
79
+ }
80
+
81
+ await savePackageJson(directory, packageJson);
82
+
83
+ // Init LDO
84
+ load.text = "Initializing LDO";
85
+ await init(directory);
86
+
87
+ // Add prepublish script
88
+ await modifyPackageJson(directory, async (packageJson) => {
89
+ if (!packageJson.scripts) packageJson.scripts = {};
90
+ packageJson.scripts.prepublish =
91
+ "npm run build:ldo & npm run generate-readme";
92
+ packageJson.scripts[
93
+ "genenerate-readme"
94
+ ] = `ldo generate-readme --project ./ --shapes ./.shapes --ldo ./.ldo`;
95
+ return packageJson;
96
+ });
97
+
98
+ // Create index.js
99
+ load.text = "Generating index.js";
100
+ const ldoDir = await fs.readdir(path.join(directory, "./.ldo"), {
101
+ withFileTypes: true,
102
+ });
103
+ const indexText = await renderFile(
104
+ path.join(__dirname, "./templates/readme/projectIndex.ejs"),
105
+ { fileNames: ldoDir.map((file) => file.name) },
106
+ );
107
+ await fs.writeFile(path.join(directory, "index.js"), indexText);
108
+
109
+ // Generate ReadMe
110
+ load.text = "Generating README";
111
+ await generateReadme({
112
+ project: directory,
113
+ shapes: path.join(directory, ".shapes"),
114
+ ldo: path.join(directory, ".ldo"),
115
+ });
116
+
117
+ load.stop();
118
+ }
@@ -0,0 +1,81 @@
1
+ import { getPackageJson } from "./util/modifyPackageJson";
2
+ import { forAllShapes } from "./util/forAllShapes";
3
+ import { promises as fs } from "fs";
4
+ import path from "path";
5
+ import { Project } from "ts-morph";
6
+ import { renderFile } from "ejs";
7
+
8
+ interface GenerateReadmeOptions {
9
+ project: string;
10
+ shapes: string;
11
+ ldo: string;
12
+ }
13
+
14
+ interface ReadmeEjsOptions {
15
+ projectName: string;
16
+ projectDescription: string;
17
+ shapes: {
18
+ name: string;
19
+ types: {
20
+ typeName: string;
21
+ shapeTypeName: string;
22
+ }[];
23
+ shex: string;
24
+ typescript: string;
25
+ }[];
26
+ }
27
+
28
+ export async function generateReadme(options: GenerateReadmeOptions) {
29
+ const packageJson = await getPackageJson(options.project);
30
+ const projectName = packageJson.name!;
31
+ const projectDescription = packageJson.description!;
32
+ const shapes: ReadmeEjsOptions["shapes"] = [];
33
+
34
+ await forAllShapes(options.shapes, async (fileName, shexC) => {
35
+ const typeFilePath = path.join(options.ldo, `${fileName}.typings.ts`);
36
+
37
+ const typesRaw = await fs.readFile(typeFilePath, "utf8");
38
+
39
+ const shape: ReadmeEjsOptions["shapes"][0] = {
40
+ name: fileName,
41
+ shex: shexC,
42
+ typescript: typesRaw,
43
+ types: [],
44
+ };
45
+
46
+ listInterfaces(typeFilePath).forEach((interfaceName) => {
47
+ shape.types.push({
48
+ typeName: interfaceName,
49
+ shapeTypeName: `${interfaceName}ShapeType`,
50
+ });
51
+ });
52
+
53
+ shapes.push(shape);
54
+ });
55
+
56
+ const readmeEjsOptions: ReadmeEjsOptions = {
57
+ projectName,
58
+ projectDescription,
59
+ shapes,
60
+ };
61
+
62
+ // Save Readme
63
+ const finalContent = await renderFile(
64
+ path.join(__dirname, "./templates/readme/", "main.ejs"),
65
+ readmeEjsOptions,
66
+ );
67
+ // Save readme to document
68
+ await fs.writeFile(path.join(options.project, "README.md"), finalContent);
69
+ }
70
+
71
+ /**
72
+ * Helper Function that lists all the interfaces in a typescript file
73
+ */
74
+ function listInterfaces(filePath: string): string[] {
75
+ const project = new Project();
76
+ const sourceFile = project.addSourceFileAtPath(filePath);
77
+
78
+ // Get all interfaces in the file
79
+ const interfaces = sourceFile.getInterfaces().map((iface) => iface.getName());
80
+ return interfaces;
81
+ }
package/src/index.ts CHANGED
@@ -3,6 +3,7 @@
3
3
  import { program } from "commander";
4
4
  import { build } from "./build";
5
5
  import { init } from "./init";
6
+ import { create } from "./create";
6
7
 
7
8
  program
8
9
  .name("LDO-CLI")
@@ -18,8 +19,34 @@ program
18
19
 
19
20
  program
20
21
  .command("init")
21
- .option("-d --directory>", "A parent directory for ldo files")
22
+ .argument("[directory]", "A parent directory for ldo files")
22
23
  .description("Initializes a project for LDO.")
23
24
  .action(init);
24
25
 
26
+ program
27
+ .command("create")
28
+ .argument("<directory>", "The package's directory")
29
+ .description("Creates a standalone package for shapes to publish to NPM.")
30
+ .action(create);
31
+
32
+ program
33
+ .command("generate-readme")
34
+ .description("Create a ReadMe from the shapes and generated code.")
35
+ .requiredOption(
36
+ "-r, --readme <readmePath>",
37
+ "Provide the path to the readme",
38
+ "./.shapes",
39
+ )
40
+ .requiredOption(
41
+ "-s, --shapes <shapesPath>",
42
+ "Provide the path to the shapes folder",
43
+ "./.shapes",
44
+ )
45
+ .requiredOption(
46
+ "-s, --ldo <ldoPath>",
47
+ "Provide the path to the ldo folder",
48
+ "./.ldo",
49
+ )
50
+ .action(build);
51
+
25
52
  program.parse();
package/src/init.ts CHANGED
@@ -2,22 +2,15 @@ import { exec } from "child-process-promise";
2
2
  import fs from "fs-extra";
3
3
  import path from "path";
4
4
  import { renderFile } from "ejs";
5
+ import { modifyPackageJson } from "./util/modifyPackageJson";
5
6
 
6
7
  const DEFAULT_SHAPES_FOLDER = "./.shapes";
7
8
  const DEFAULT_LDO_FOLDER = "./.ldo";
8
9
  const POTENTIAL_PARENT_DIRECTORIES = ["src", "lib", "bin"];
9
10
 
10
- export interface InitOptions {
11
- directory?: string;
12
- }
13
-
14
- export async function init(initOptions: InitOptions) {
15
- // Install dependencies
16
- await exec("npm install @ldo/ldo --save");
17
- await exec("npm install @ldo/cli @types/shexj @types/jsonld --save-dev");
18
-
11
+ export async function init(directory?: string) {
19
12
  // Find folder to save to
20
- let parentDirectory = initOptions.directory;
13
+ let parentDirectory = directory!;
21
14
  if (!parentDirectory) {
22
15
  parentDirectory = "./";
23
16
  const allDirectories = (
@@ -37,6 +30,12 @@ export async function init(initOptions: InitOptions) {
37
30
  }
38
31
  }
39
32
 
33
+ // Install dependencies
34
+ await exec(`cd ${parentDirectory} && npm install @ldo/ldo --save`);
35
+ await exec(
36
+ `cd ${parentDirectory} && npm install @ldo/cli @types/shexj @types/jsonld --save-dev`,
37
+ );
38
+
40
39
  // Create "shapes" folder
41
40
  const shapesFolderPath = path.join(parentDirectory, DEFAULT_SHAPES_FOLDER);
42
41
  await fs.promises.mkdir(shapesFolderPath);
@@ -57,22 +56,18 @@ export async function init(initOptions: InitOptions) {
57
56
  );
58
57
 
59
58
  // Add build script
60
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
61
- const packageJson: any = JSON.parse(
62
- (await fs.promises.readFile("./package.json")).toString(),
63
- );
64
- if (!packageJson.scripts) {
65
- packageJson.scripts = {};
66
- }
67
- const ldoFolder = path.join(parentDirectory, DEFAULT_LDO_FOLDER);
68
- packageJson.scripts[
69
- "build:ldo"
70
- ] = `ldo build --input ${shapesFolderPath} --output ${ldoFolder}`;
71
- await fs.promises.writeFile(
72
- "./package.json",
73
- JSON.stringify(packageJson, null, 2),
74
- );
59
+ await modifyPackageJson(parentDirectory, async (packageJson) => {
60
+ if (!packageJson.scripts) {
61
+ packageJson.scripts = {};
62
+ }
63
+ const ldoFolder = path.join(parentDirectory, DEFAULT_LDO_FOLDER);
64
+ packageJson.scripts["build:ldo"] = `ldo build --input ${path.relative(
65
+ parentDirectory,
66
+ shapesFolderPath,
67
+ )} --output ${path.relative(parentDirectory, ldoFolder)}`;
68
+ return packageJson;
69
+ });
75
70
 
76
71
  // Build LDO
77
- await exec("npm run build:ldo");
72
+ await exec(`cd ${parentDirectory} && npm run build:ldo`);
78
73
  }
@@ -1,8 +1,8 @@
1
- import { ContextDefinition } from "jsonld";
1
+ import { LdoJsonldContext } from "@ldo/jsonld-dataset-proxy";
2
2
 
3
3
  /**
4
4
  * =============================================================================
5
5
  * <%- fileName %>Context: JSONLD Context for <%- fileName %>
6
6
  * =============================================================================
7
7
  */
8
- export const <%- fileName %>Context: ContextDefinition = <%- context %>;
8
+ export const <%- fileName %>Context: LdoJsonldContext = <%- context %>;
@@ -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,2 @@
1
+ <% fileNames.forEach((fileName) => { %>export * from "./.ldo/<%- fileName %>";
2
+ <% }); %>
@@ -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,26 @@
1
+ import fs from "fs";
2
+ import path from "path";
3
+
4
+ export async function forAllShapes(
5
+ shapePath: string,
6
+ callback: (filename: string, shape: string) => Promise<void>,
7
+ ): Promise<void> {
8
+ const shapeDir = await fs.promises.readdir(shapePath, {
9
+ withFileTypes: true,
10
+ });
11
+ // Filter out non-shex documents
12
+ const shexFiles = shapeDir.filter(
13
+ (file) => file.isFile() && file.name.endsWith(".shex"),
14
+ );
15
+ await Promise.all(
16
+ shexFiles.map(async (file) => {
17
+ const fileName = path.parse(file.name).name;
18
+ // Get the content of each document
19
+ const shexC = await fs.promises.readFile(
20
+ path.join(shapePath, file.name),
21
+ "utf8",
22
+ );
23
+ await callback(fileName, shexC);
24
+ }),
25
+ );
26
+ }
@@ -0,0 +1,33 @@
1
+ import type { PackageJson } from "type-fest";
2
+ import fs from "fs-extra";
3
+ import path from "path";
4
+
5
+ export async function getPackageJson(
6
+ projectFolder: string,
7
+ ): Promise<PackageJson> {
8
+ return JSON.parse(
9
+ (
10
+ await fs.promises.readFile(path.join(projectFolder, "./package.json"))
11
+ ).toString(),
12
+ );
13
+ }
14
+
15
+ export async function savePackageJson(
16
+ projectFolder: string,
17
+ packageJson: PackageJson,
18
+ ): Promise<void> {
19
+ await fs.promises.mkdir(projectFolder, { recursive: true });
20
+ await fs.promises.writeFile(
21
+ path.join(projectFolder, "./package.json"),
22
+ JSON.stringify(packageJson, null, 2),
23
+ );
24
+ }
25
+
26
+ export async function modifyPackageJson(
27
+ projectFolder: string,
28
+ modifyCallback: (packageJson: PackageJson) => Promise<PackageJson>,
29
+ ): Promise<void> {
30
+ const packageJson: PackageJson = await getPackageJson(projectFolder);
31
+ const newPackageJson = await modifyCallback(packageJson);
32
+ await savePackageJson(projectFolder, newPackageJson);
33
+ }