Adds an --init script to start a boilerplate project.

.vscode/settings.json

@@ -1,8 +1,8 @@
 {
   "yaml.schemas": {
     "static/ld-workbench.schema.json": [
-      "configurations/*.yml",
-      "static/example/*.yml"
+      "pipelines/configurations/**/*.yml",
+      "static/example/*.yml",
     ],
   }
 }

README.md

@@ -4,6 +4,25 @@ LDWorkbench is a Linked Data Transformation tool designed to use only SPARQL as
 
 This project is currently in a Proof of Concept phase, feel free to watch our progress, but please do not use this project in a production setup.
 
+## Install & Usage
+The quickest way to get started with LDWorkbench is follow these instruction:
+
+```bash
+mkdir ldworkbench
+cd ldworkbench
+npm i git+https://github.com/netwerk-digitaal-erfgoed/ld-workbench.git
+npx ldworkbench --init
+```
+
+Your workbench is now ready for use. An example workbench is provided, run it with this command:
+
+```bash
+npx ldworkbench
+```
+
+### Configuring a workbench project
+
+
 ## Development
 For local development, these script should get you going:
 ```bash

package.json

@@ -1,8 +1,8 @@
 {
-  "name": "ld-workbench",
+  "name": "ldworkbench",
   "type": "module",
   "bin": {
-    "ld-workbench": "dist/main.js"
+    "ldworkbench": "dist/main.js"
   },
   "version": "0.0.1",
   "description": "LDWorkbench is a Linked Data Transformation tool designed to use only SPARQL as transformation language.",
@@ -12,8 +12,8 @@
     "prepare": "husky install",
     "build": "npx tsc",
     "dev": "npx tsc --watch --preserveWatchOutput",
-    "ld-workbench": "node dist/main",
-    "ld-workbench:example": "node dist/main --configDir static",
+    "ldworkbench": "node dist/main",
+    "ldworkbench:example": "node dist/main --configDir static",
     "util:lint": "ESLINT_STRICT=true ESLINT_EXPENSIVE=true eslint --ext .tsx --ext .ts  ./src",
     "util:json-schema-to-typescript": "npx json2ts -i ./static/ld-workbench.schema.json -o src/lib/LDWorkbenchConfiguration.d.ts"
   },

src/cliArgs.ts

@@ -2,6 +2,7 @@ import chalk from 'chalk';
 import { program } from 'commander';
 import { error } from './utils/error.js';
 import version from './utils/version.js';
+import init from './utils/init.js';
 
 program
   .name('ld-workbench')
@@ -10,14 +11,30 @@ program
   .option('--configDir </path/to/yaml/>', 'Path to a folder containing your configuration files.')
   .option('-p, --pipeline <name-of-pipeline>', 'Name of the pipeline you want to run')
   .option('-s, --stage <name-of-stage>', 'Name of the stage of the pipeline you want to run')
+  .option('--init', 'Initializes a new LDWorkbench project')
   .version(version());
 program.parse();
 export const cliArgs: {
   config?: string;
   configDir?: string;
   pipeline?: string;
   stage?: string
+  init?: boolean
 } = program.opts();
+
+if (cliArgs.init !== undefined) {
+  if(Object.values(cliArgs).length !== 1) {
+    error('The --init flag can not be used in conjuction with other CLI arguments.')    
+  }
+  try {
+    init()
+    console.log(chalk.green('A boilerplate LDWorkbech has been created. You can now run a project using `npx ldworkbench`.'))
+  } catch(e) {
+    error(e as Error)
+  }
+  process.exit(0)
+}
+
 if (cliArgs.config !== undefined && cliArgs.configDir !== undefined) {
   error(
     'Do not use both the --config and the --configDir options.',

src/lib/Pipeline.class.ts

@@ -21,7 +21,7 @@ class Pipeline {
     private readonly $configuration: LDWorkbenchConfiguration
   ) {
     //  create data folder:
-    this.dataDir = path.join("data", kebabcase(this.$configuration.name));
+    this.dataDir = path.join("pipelines", "data", kebabcase(this.$configuration.name));
     fs.mkdirSync(this.dataDir, { recursive: true });
     const destinationFile = this.configuration.destination ?? `file://${path.join(this.dataDir, 'statements.nt')}`
     if (!isFilePathString(destinationFile)) {

src/main.ts → src/main.tsx

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 import inquirer from 'inquirer'
 import chalk from 'chalk'
 import { error } from './utils/error.js'

src/utils/init.ts

@@ -0,0 +1,73 @@
+import fs from 'fs';
+import { fileURLToPath } from 'url';
+import * as path from 'path';
+import glob from 'glob'
+
+export default function init(): void {
+  const $dirname = path.dirname(fileURLToPath(import.meta.url));
+  if(fs.existsSync('pipelines')) {
+    throw new Error('The --init script found an existing directory "pipelines". Make sure this directory does not exists before running this script.')
+  }
+  fs.mkdirSync('pipelines')
+  fs.mkdirSync(path.join('pipelines', 'data'))
+  fs.mkdirSync(path.join('pipelines', 'configurations'))
+  fs.mkdirSync(path.join('pipelines', 'configurations', 'example'))
+  const filepaths = glob.sync(path.join($dirname, '..', '..', 'static', 'example', '*'))
+  for(const filepath of filepaths) {
+    fs.copyFileSync(filepath, path.join('pipelines', 'configurations', 'example', path.basename(filepath)))
+  }
+  const yamlFile = path.join('pipelines', 'configurations', 'example', 'config.yml')
+  const yaml = fs.readFileSync(yamlFile, 'utf-8')
+    .replaceAll(/\/static\//g, '/pipelines/configurations/')
+  fs.writeFileSync(yamlFile, yaml)
+
+  const yamlSchemasSettings = {
+    "yaml.schemas": {
+      "node_modules/ldworkbench/static/ld-workbench.schema.json": [
+        "pipelines/configurations/**/*.yml",
+        "static/example/*.yml",
+      ],
+    }
+  }
+
+  const extensions = [
+		"dbaeumer.vscode-eslint",
+    "stardog-union.vscode-langserver-sparql",
+    "stardog-union.stardog-rdf-grammars",
+    "MarkLindeman.turtle-vocab-autocomplete"
+	]
+
+  // setting up VSC/Git settings, if this fails, that's fine:
+  try {
+    if (!fs.existsSync('.gitignore')) {
+      fs.writeFileSync('.gitignore', 'node_modules\n')
+    }
+    if (!fs.existsSync('.vscode')) fs.mkdirSync('.vscode')
+    const settingsFile = path.join('.vscode', 'settings.json')
+    const extensionsFile = path.join('.vscode', 'extensions.json')
+    if (!fs.existsSync(settingsFile)) {
+      fs.writeFileSync(settingsFile, JSON.stringify(yamlSchemasSettings, undefined, 2))
+    } else {
+      const settings = JSON.parse(fs.readFileSync(settingsFile, 'utf-8'))
+      if (!Object.hasOwn(settings, 'yaml.schemas')) {
+        settings['yaml.schemas'] = yamlSchemasSettings['yaml.schemas']
+      } else {
+        settings['yaml.schemas']["node_modules/ldworkbench/static/ld-workbench.schema.json"]  = yamlSchemasSettings['yaml.schemas']["node_modules/ldworkbench/static/ld-workbench.schema.json"]
+      }
+      fs.writeFileSync(settingsFile, JSON.stringify(yamlSchemasSettings, undefined, 2))
+    }
+
+    if (!fs.existsSync(extensionsFile)) {
+      fs.writeFileSync(extensionsFile, JSON.stringify({recommendations: extensions}, undefined, 2))
+    } else {
+      const settings = JSON.parse(fs.readFileSync(settingsFile, 'utf-8'))
+      if (!Object.hasOwn(settings, 'recommendations')) {
+        settings.recommendations = extensions
+      } else {
+        settings.recommendations = (settings.recommendations as string[]).concat(extensions)
+      }
+      fs.writeFileSync(settingsFile, JSON.stringify(settingsFile, undefined, 2))
+    }
+  } catch(e) {}
+
+}

src/utils/loadPipelines.ts

@@ -8,7 +8,7 @@ export default function loadPipelines (configDirOrFile: string): Map<string, LDW
   const pipelines = new Map<string, LDWorkbenchConfiguration>()
 
   if (!fs.existsSync(configDirOrFile))
-    throw new Error(`Configuration directory/file ${chalk.italic(configDirOrFile)} could not be found.`)
+    throw new Error(`Configuration directory/file ${chalk.italic(configDirOrFile)} could not be found.\nIf this is your first run of LDWorkbench, you might want to use \`npx ldworkbench --init\` to setup an example workbench project.`)
 
   const files: string[] = []
   if (fs.lstatSync(configDirOrFile).isDirectory()) {

src/utils/validate.ts

@@ -1,5 +1,7 @@
 import Ajv, { type ValidateFunction, type ErrorObject } from 'ajv';
 import parseYamlFile from './parseYamlFile.js';
+import { fileURLToPath } from 'url';
+import * as path from 'path';
 
 /**
  * Validate an object against a JSON Schema provided as a YAML file.
@@ -9,7 +11,9 @@ import parseYamlFile from './parseYamlFile.js';
  */
 export default function validate(filePathOrObject: object | string): ErrorObject[] | null {
   // Parse the YAML schema file
-  const schema = parseYamlFile('./static/ld-workbench.schema.json');
+  const dirname = path.dirname(fileURLToPath(import.meta.url));
+  const filename = path.resolve(path.join(dirname, '..', '..', 'static', 'ld-workbench.schema.json'))
+  const schema = parseYamlFile(filename);
   const configuration = typeof filePathOrObject === 'string' 
     ? parseYamlFile(filePathOrObject)
     : filePathOrObject

src/utils/version.ts

@@ -1,6 +1,9 @@
 import fs from 'fs';
-
+import { fileURLToPath } from 'url';
+import * as path from 'path';
 export default function version(): string {
-  const { version } = JSON.parse(fs.readFileSync('./package.json', 'utf-8'));
+  const dirname = path.dirname(fileURLToPath(import.meta.url));
+  const filename = path.resolve(path.join(dirname, '..', '..', 'package.json'))
+  const { version } = JSON.parse(fs.readFileSync(filename, 'utf-8'));
   return version;
 }

static/example/config.yml

@@ -6,7 +6,7 @@ description: >
 
 
 # This is optional, by default it will be stored in the data directory of the pipeline using filename 'statements.nt'
-destination: file://data/example-pipeline.nt
+destination: file://pipelines/data/example-pipeline.nt
 
 # The individual stages for your pipeline
 stages: