create-directus-extension 1.3.2 → 9.0.0-rc.93

package/lib/index.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+'use strict';
+
+const inquirer = require('inquirer');
+const { EXTENSION_TYPES, EXTENSION_LANGUAGES } = require('@directus/shared/constants');
+const { create } = require('@directus/extensions-sdk/cli');
+
+run();
+
+async function run() {
+	// eslint-disable-next-line no-console
+	console.log('This utility will walk you through creating a Directus extension.\n');
+
+	const { type, name, language } = await inquirer.prompt([
+		{
+			type: 'list',
+			name: 'type',
+			message: 'Choose the extension type',
+			choices: EXTENSION_TYPES,
+		},
+		{
+			type: 'input',
+			name: 'name',
+			message: 'Choose a name for the extension',
+		},
+		{
+			type: 'list',
+			name: 'language',
+			message: 'Choose the language to use',
+			choices: EXTENSION_LANGUAGES,
+		},
+	]);
+
+	await create(type, name, { language });
+}

package/package.json

@@ -1,63 +1,26 @@
 {
-  "name": "create-directus-extension",
-  "version": "1.3.2",
-  "description": "Command line toolkit to help users bootstrap custom Directus extensions",
-  "main": "dist/src/index.js",
-  "bin": "./dist/src/index.js",
-  "files": [
-    "dist",
-    "src/templates"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "prepack": "npm run build"
-  },
-  "release": {
-    "branches": [
-      "main"
-    ],
-    "plugins": [
-      "@semantic-release/commit-analyzer",
-      "@semantic-release/release-notes-generator",
-      "@semantic-release/npm",
-      "@semantic-release/github",
-      [
-        "@semantic-release/git",
-        {
-          "assets": [
-            "package.json"
-          ],
-          "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-        }
-      ]
-    ]
-  },
-  "keywords": [
-    "directus",
-    "extension"
-  ],
-  "author": "Joonas Palosuo <joonas.palosuo@gmail.com>",
-  "license": "GPL-3.0-only",
-  "dependencies": {
-    "chalk": "4.1.0",
-    "commander": "6.2.0",
-    "execa": "4.1.0",
-    "fs-extra": "9.0.1",
-    "mustache": "4.2.0",
-    "ora": "5.1.0",
-    "typescript": "4.2.4"
-  },
-  "devDependencies": {
-    "@semantic-release/git": "9.0.0",
-    "@types/fs-extra": "9.0.10",
-    "@types/mustache": "4.1.1",
-    "@types/node": "14.14.37",
-    "@typescript-eslint/eslint-plugin": "4.20.0",
-    "@typescript-eslint/parser": "4.20.0",
-    "eslint": "7.23.0",
-    "eslint-config-prettier": "8.1.0",
-    "eslint-plugin-prettier": "3.3.1",
-    "prettier": "2.2.1",
-    "semantic-release": "17.4.2"
-  }
+	"name": "create-directus-extension",
+	"version": "9.0.0-rc.93",
+	"description": "A small util that will scaffold a Directus extension.",
+	"main": "lib/index.js",
+	"bin": {
+		"create-directus-extension": "./lib/index.js",
+		"cde": "./lib/index.js"
+	},
+	"keywords": [
+		"directus",
+		"extensions"
+	],
+	"author": "Nicola Krumschmidt",
+	"contributors": [
+		"Joonas Palosuo <joonas.palosuo@gmail.com>",
+		"Rijk van Zanten <rijkvanzanten@me.com>"
+	],
+	"license": "GPL-3.0-only",
+	"gitHead": "61a368523b1fc4968ca456a610bc7de10be46dc1",
+	"dependencies": {
+		"@directus/extensions-sdk": "9.0.0-rc.93",
+		"@directus/shared": "9.0.0-rc.93",
+		"inquirer": "^8.1.2"
+	}
 }

package/readme.md

@@ -0,0 +1,15 @@
+# create-directus-extension
+
+A small util that will scaffold a Directus extension.
+
+## Installation
+
+This package is meant to be used through `npm` or `yarn`:
+
+```
+npm init directus-extension
+```
+
+```
+yarn create directus-extension
+```

package/README.md

@@ -1,40 +0,0 @@
-# create-directus-extension
-
-A command line helper for bootstrapping custom Directus extensions in Typescript and Javascript.
-
-## Installation
-
-This package is meant to be used through `npx` or `yarn`, for example:
-
-```bash
-npx create-directus-extension interface my-interface
-```
-
-```bash
-yarn create directus-extension display my-display
-```
-
-## Usage
-
-The tool accepts two arguments and an optional flag:
-
-```bash
-npx create-directus-extension <extension-type> <extension-name> [-j]
-```
-
-Here `<extension-type>` can be any one of the following:
-
-```
-display
-interface
-layout
-module
-endpoint
-hook
-```
-
-which correspond to the different extensions supported by Directus, as explained here: https://docs.directus.io/concepts/extensions/
-
-`<extension-name>` can be any name you choose, and will be used to create a directory for the new extension. Then name you give must not conflict with an existing directory or file!
-
-The CLI generates the project with a Typescript template by default. If you would rather develop the project in Javascript, an optional flag of `-j` or `--javascript` can be given to the `create-directus-extension` command.

package/dist/package.json

@@ -1,63 +0,0 @@
-{
-    "name": "create-directus-extension",
-    "version": "1.3.2",
-    "description": "Command line toolkit to help users bootstrap custom Directus extensions",
-    "main": "dist/src/index.js",
-    "bin": "./dist/src/index.js",
-    "files": [
-        "dist",
-        "src/templates"
-    ],
-    "scripts": {
-        "build": "tsc",
-        "prepack": "npm run build"
-    },
-    "release": {
-        "branches": [
-            "main"
-        ],
-        "plugins": [
-            "@semantic-release/commit-analyzer",
-            "@semantic-release/release-notes-generator",
-            "@semantic-release/npm",
-            "@semantic-release/github",
-            [
-                "@semantic-release/git",
-                {
-                    "assets": [
-                        "package.json"
-                    ],
-                    "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-                }
-            ]
-        ]
-    },
-    "keywords": [
-        "directus",
-        "extension"
-    ],
-    "author": "Joonas Palosuo <joonas.palosuo@gmail.com>",
-    "license": "GPL-3.0-only",
-    "dependencies": {
-        "chalk": "4.1.0",
-        "commander": "6.2.0",
-        "execa": "4.1.0",
-        "fs-extra": "9.0.1",
-        "mustache": "4.2.0",
-        "ora": "5.1.0",
-        "typescript": "4.2.4"
-    },
-    "devDependencies": {
-        "@semantic-release/git": "9.0.0",
-        "@types/fs-extra": "9.0.10",
-        "@types/mustache": "4.1.1",
-        "@types/node": "14.14.37",
-        "@typescript-eslint/eslint-plugin": "4.20.0",
-        "@typescript-eslint/parser": "4.20.0",
-        "eslint": "7.23.0",
-        "eslint-config-prettier": "8.1.0",
-        "eslint-plugin-prettier": "3.3.1",
-        "prettier": "2.2.1",
-        "semantic-release": "17.4.2"
-    }
-}

package/dist/src/index.js

@@ -1,143 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = __importDefault(require("commander"));
-const path_1 = __importDefault(require("path"));
-const chalk_1 = __importDefault(require("chalk"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const mustache_1 = __importDefault(require("mustache"));
-const execa_1 = __importDefault(require("execa"));
-const ora_1 = __importDefault(require("ora"));
-const pkg = __importStar(require("../package.json"));
-const VUE_EXTENSIONS = ['display', 'interface', 'layout', 'module'];
-const EXTENSION_TYPES = [...VUE_EXTENSIONS, 'endpoint', 'hook'];
-const TEMPLATE_ROOT = path_1.default.resolve(__dirname, '../../src/templates');
-const program = new commander_1.default.Command(pkg.name);
-program
-    .version(pkg.version)
-    .arguments('<type> <name>')
-    .option('-j, --javascript', 'Use Javascript instead of Typescript')
-    .description('Create a new Directus extension', {
-    type: 'Type of the extension you wish to create.\n' +
-        'Has to be one of the following:\n' +
-        `${chalk_1.default.blue(EXTENSION_TYPES.join(', '))}`,
-    name: 'Name of your custom extension and the folder to be created',
-})
-    .action(create);
-program.exitOverride((err) => {
-    if (err.code === 'commander.missingArgument') {
-        program.outputHelp();
-    }
-    process.exit(err.exitCode);
-});
-program.parse(process.argv);
-async function create(type, name, options) {
-    const targetPath = path_1.default.resolve(name);
-    if (!EXTENSION_TYPES.includes(type)) {
-        console.log(`Extension type "${chalk_1.default.red(type)}" does not exist.`);
-        console.log('Please choose one of the following:');
-        console.log(EXTENSION_TYPES.join(', '));
-        process.exit(1);
-    }
-    if (await fs_extra_1.default.pathExists(targetPath)) {
-        const stat = await fs_extra_1.default.stat(targetPath);
-        if (stat.isDirectory() === false) {
-            console.log(`Destination ${chalk_1.default.red(name)} already exists and is not a directory.`);
-            process.exit(1);
-        }
-        const files = await fs_extra_1.default.readdir(targetPath);
-        if (files.length > 0) {
-            console.log(`Destination ${chalk_1.default.red(name)} already exists and is not an empty directory.`);
-            process.exit(1);
-        }
-    }
-    const projectLanguage = options.javascript ? 'javascript' : 'typescript';
-    const templatePath = `${TEMPLATE_ROOT}/${projectLanguage}/${type}`;
-    if (!(await fs_extra_1.default.pathExists(`${templatePath}/index.${projectLanguage.charAt(0)}s`)) &&
-        !(await fs_extra_1.default.pathExists(`${templatePath}/src/index.${projectLanguage.charAt(0)}s`))) {
-        console.log(`Bootstrapping ${chalk_1.default.red(type)}s in ${projectLanguage} is not yet supported.`);
-        console.log('Follow the development of this toolkit here:');
-        console.log('https://github.com/directus-community/extension-toolkit');
-        process.exit(1);
-    }
-    const spinner = ora_1.default(`Setting up ${type} boilerplate`).start();
-    await fs_extra_1.default.ensureDir(targetPath);
-    // Copy over files
-    fs_extra_1.default.copy(templatePath, targetPath, { filter: fileFilter }, (e) => e && console.error(e));
-    fs_extra_1.default.copy(`${TEMPLATE_ROOT}/common`, targetPath, { filter: fileFilter }, (e) => e && console.error(e));
-    fs_extra_1.default.copy(`${TEMPLATE_ROOT}/${projectLanguage}/common`, targetPath, { filter: fileFilter }, (e) => e && console.error(e));
-    if (VUE_EXTENSIONS.includes(type)) {
-        fs_extra_1.default.copy(`${TEMPLATE_ROOT}/${projectLanguage}/common.vue`, targetPath, { filter: fileFilter }, (e) => e && console.error(e));
-    }
-    // Parse package.json from common, unique and template files
-    const commonPackageJson = await fs_extra_1.default.readJSON(`${TEMPLATE_ROOT}/${projectLanguage}/common/package.json.template`);
-    const uniquePackageJsonPath = `${templatePath}/package.json.template`;
-    let templatePackageJson;
-    if (await fs_extra_1.default.pathExists(uniquePackageJsonPath)) {
-        templatePackageJson = await fs_extra_1.default.readJSON(uniquePackageJsonPath);
-    }
-    else {
-        templatePackageJson = {};
-    }
-    let vuePackageJson;
-    if (VUE_EXTENSIONS.includes(type)) {
-        vuePackageJson = await fs_extra_1.default.readJSON(`${TEMPLATE_ROOT}/${projectLanguage}/common.vue/package.json.template`);
-    }
-    else {
-        vuePackageJson = {};
-    }
-    const packageJsonTemplate = await fs_extra_1.default.readFile(`${TEMPLATE_ROOT}/package.json.mustache`, 'utf-8');
-    const mustacheView = {
-        name,
-        type,
-        ...stringifyTemplateObjects(['dependencies', 'devDependencies', 'scripts'], [commonPackageJson, templatePackageJson, vuePackageJson]),
-    };
-    const renderedPackageJson = mustache_1.default.render(packageJsonTemplate, mustacheView);
-    fs_extra_1.default.writeJSON(`${targetPath}/package.json`, JSON.parse(renderedPackageJson), { spaces: 2 });
-    await execa_1.default('npm', ['install'], { cwd: targetPath });
-    spinner.stop();
-    console.log(`Extension set up successfully! Start your development with "cd ${name}"`);
-    console.log('Also be sure to check out the relevant documentation:');
-    const documentationSlug = VUE_EXTENSIONS.includes(type) ? type : `api-${type}`;
-    console.log(`https://docs.directus.io/guides/${documentationSlug}s/`);
-    process.exit(0);
-}
-/** Selects all files excluding those with `.template` suffix */
-function fileFilter(filename) {
-    return !filename.endsWith('template');
-}
-/**
- * Merge templates of package.json into one object with string values,
- * so that they can be passed to Mustache templating
- */
-function stringifyTemplateObjects(keys, templates) {
-    return Object.fromEntries(keys.map((key) => [
-        key,
-        JSON.stringify(templates
-            .map((template) => template[key] || {})
-            .reduce((acc, curr) => ({ ...acc, ...curr }), {})),
-    ]));
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUVBLDBEQUFrQztBQUNsQyxnREFBd0I7QUFDeEIsa0RBQTBCO0FBQzFCLHdEQUEyQjtBQUMzQix3REFBZ0M7QUFDaEMsa0RBQTBCO0FBQzFCLDhDQUFzQjtBQUV0QixxREFBdUM7QUFFdkMsTUFBTSxjQUFjLEdBQUcsQ0FBQyxTQUFTLEVBQUUsV0FBVyxFQUFFLFFBQVEsRUFBRSxRQUFRLENBQUMsQ0FBQztBQUNwRSxNQUFNLGVBQWUsR0FBRyxDQUFDLEdBQUcsY0FBYyxFQUFFLFVBQVUsRUFBRSxNQUFNLENBQUMsQ0FBQztBQUVoRSxNQUFNLGFBQWEsR0FBRyxjQUFJLENBQUMsT0FBTyxDQUFDLFNBQVMsRUFBRSxxQkFBcUIsQ0FBQyxDQUFDO0FBRXJFLE1BQU0sT0FBTyxHQUFHLElBQUksbUJBQVMsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO0FBRWhELE9BQU87S0FDTCxPQUFPLENBQUMsR0FBRyxDQUFDLE9BQU8sQ0FBQztLQUNwQixTQUFTLENBQUMsZUFBZSxDQUFDO0tBQzFCLE1BQU0sQ0FBQyxrQkFBa0IsRUFBRSxzQ0FBc0MsQ0FBQztLQUNsRSxXQUFXLENBQUMsaUNBQWlDLEVBQUU7SUFDL0MsSUFBSSxFQUNILDZDQUE2QztRQUM3QyxtQ0FBbUM7UUFDbkMsR0FBRyxlQUFLLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRTtJQUM1QyxJQUFJLEVBQUUsNERBQTREO0NBQ2xFLENBQUM7S0FDRCxNQUFNLENBQUMsTUFBTSxDQUFDLENBQUM7QUFFakIsT0FBTyxDQUFDLFlBQVksQ0FBQyxDQUFDLEdBQUcsRUFBRSxFQUFFO0lBQzVCLElBQUksR0FBRyxDQUFDLElBQUksS0FBSywyQkFBMkIsRUFBRTtRQUM3QyxPQUFPLENBQUMsVUFBVSxFQUFFLENBQUM7S0FDckI7SUFDRCxPQUFPLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxRQUFRLENBQUMsQ0FBQztBQUM1QixDQUFDLENBQUMsQ0FBQztBQUVILE9BQU8sQ0FBQyxLQUFLLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO0FBRTVCLEtBQUssVUFBVSxNQUFNLENBQUMsSUFBWSxFQUFFLElBQVksRUFBRSxPQUFtQztJQUNwRixNQUFNLFVBQVUsR0FBRyxjQUFJLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO0lBRXRDLElBQUksQ0FBQyxlQUFlLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ3BDLE9BQU8sQ0FBQyxHQUFHLENBQUMsbUJBQW1CLGVBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLG1CQUFtQixDQUFDLENBQUM7UUFDbkUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxxQ0FBcUMsQ0FBQyxDQUFDO1FBQ25ELE9BQU8sQ0FBQyxHQUFHLENBQUMsZUFBZSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO1FBQ3hDLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUM7S0FDaEI7SUFFRCxJQUFJLE1BQU0sa0JBQUcsQ0FBQyxVQUFVLENBQUMsVUFBVSxDQUFDLEVBQUU7UUFDckMsTUFBTSxJQUFJLEdBQUcsTUFBTSxrQkFBRyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUV4QyxJQUFJLElBQUksQ0FBQyxXQUFXLEVBQUUsS0FBSyxLQUFLLEVBQUU7WUFDakMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxlQUFlLGVBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLHlDQUF5QyxDQUFDLENBQUM7WUFDckYsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztTQUNoQjtRQUVELE1BQU0sS0FBSyxHQUFHLE1BQU0sa0JBQUcsQ0FBQyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUM7UUFFNUMsSUFBSSxLQUFLLENBQUMsTUFBTSxHQUFHLENBQUMsRUFBRTtZQUNyQixPQUFPLENBQUMsR0FBRyxDQUFDLGVBQWUsZUFBSyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsZ0RBQWdELENBQUMsQ0FBQztZQUM1RixPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO1NBQ2hCO0tBQ0Q7SUFFRCxNQUFNLGVBQWUsR0FBRyxPQUFPLENBQUMsVUFBVSxDQUFDLENBQUMsQ0FBQyxZQUFZLENBQUMsQ0FBQyxDQUFDLFlBQVksQ0FBQztJQUN6RSxNQUFNLFlBQVksR0FBRyxHQUFHLGFBQWEsSUFBSSxlQUFlLElBQUksSUFBSSxFQUFFLENBQUM7SUFFbkUsSUFDQyxDQUFDLENBQUMsTUFBTSxrQkFBRyxDQUFDLFVBQVUsQ0FBQyxHQUFHLFlBQVksVUFBVSxlQUFlLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUM5RSxDQUFDLENBQUMsTUFBTSxrQkFBRyxDQUFDLFVBQVUsQ0FBQyxHQUFHLFlBQVksY0FBYyxlQUFlLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUMsQ0FBQyxFQUNqRjtRQUNELE9BQU8sQ0FBQyxHQUFHLENBQUMsaUJBQWlCLGVBQUssQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLFFBQVEsZUFBZSx3QkFBd0IsQ0FBQyxDQUFDO1FBQzdGLE9BQU8sQ0FBQyxHQUFHLENBQUMsOENBQThDLENBQUMsQ0FBQztRQUM1RCxPQUFPLENBQUMsR0FBRyxDQUFDLHlEQUF5RCxDQUFDLENBQUM7UUFDdkUsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztLQUNoQjtJQUNELE1BQU0sT0FBTyxHQUFHLGFBQUcsQ0FBQyxjQUFjLElBQUksY0FBYyxDQUFDLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDOUQsTUFBTSxrQkFBRyxDQUFDLFNBQVMsQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUVoQyxrQkFBa0I7SUFDbEIsa0JBQUcsQ0FBQyxJQUFJLENBQUMsWUFBWSxFQUFFLFVBQVUsRUFBRSxFQUFFLE1BQU0sRUFBRSxVQUFVLEVBQUUsRUFBRSxDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxJQUFJLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUN6RixrQkFBRyxDQUFDLElBQUksQ0FDUCxHQUFHLGFBQWEsU0FBUyxFQUN6QixVQUFVLEVBQ1YsRUFBRSxNQUFNLEVBQUUsVUFBVSxFQUFFLEVBQ3RCLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLElBQUksT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FDNUIsQ0FBQztJQUNGLGtCQUFHLENBQUMsSUFBSSxDQUNQLEdBQUcsYUFBYSxJQUFJLGVBQWUsU0FBUyxFQUM1QyxVQUFVLEVBQ1YsRUFBRSxNQUFNLEVBQUUsVUFBVSxFQUFFLEVBQ3RCLENBQUMsQ0FBQyxFQUFFLEVBQUUsQ0FBQyxDQUFDLElBQUksT0FBTyxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FDNUIsQ0FBQztJQUNGLElBQUksY0FBYyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsRUFBRTtRQUNsQyxrQkFBRyxDQUFDLElBQUksQ0FDUCxHQUFHLGFBQWEsSUFBSSxlQUFlLGFBQWEsRUFDaEQsVUFBVSxFQUNWLEVBQUUsTUFBTSxFQUFFLFVBQVUsRUFBRSxFQUN0QixDQUFDLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FBQyxJQUFJLE9BQU8sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQzVCLENBQUM7S0FDRjtJQUVELDREQUE0RDtJQUM1RCxNQUFNLGlCQUFpQixHQUFHLE1BQU0sa0JBQUcsQ0FBQyxRQUFRLENBQzNDLEdBQUcsYUFBYSxJQUFJLGVBQWUsK0JBQStCLENBQ2xFLENBQUM7SUFFRixNQUFNLHFCQUFxQixHQUFHLEdBQUcsWUFBWSx3QkFBd0IsQ0FBQztJQUN0RSxJQUFJLG1CQUFtQixDQUFDO0lBQ3hCLElBQUksTUFBTSxrQkFBRyxDQUFDLFVBQVUsQ0FBQyxxQkFBcUIsQ0FBQyxFQUFFO1FBQ2hELG1CQUFtQixHQUFHLE1BQU0sa0JBQUcsQ0FBQyxRQUFRLENBQUMscUJBQXFCLENBQUMsQ0FBQztLQUNoRTtTQUFNO1FBQ04sbUJBQW1CLEdBQUcsRUFBRSxDQUFDO0tBQ3pCO0lBRUQsSUFBSSxjQUFjLENBQUM7SUFDbkIsSUFBSSxjQUFjLENBQUMsUUFBUSxDQUFDLElBQUksQ0FBQyxFQUFFO1FBQ2xDLGNBQWMsR0FBRyxNQUFNLGtCQUFHLENBQUMsUUFBUSxDQUNsQyxHQUFHLGFBQWEsSUFBSSxlQUFlLG1DQUFtQyxDQUN0RSxDQUFDO0tBQ0Y7U0FBTTtRQUNOLGNBQWMsR0FBRyxFQUFFLENBQUM7S0FDcEI7SUFFRCxNQUFNLG1CQUFtQixHQUFHLE1BQU0sa0JBQUcsQ0FBQyxRQUFRLENBQUMsR0FBRyxhQUFhLHdCQUF3QixFQUFFLE9BQU8sQ0FBQyxDQUFDO0lBQ2xHLE1BQU0sWUFBWSxHQUFHO1FBQ3BCLElBQUk7UUFDSixJQUFJO1FBQ0osR0FBRyx3QkFBd0IsQ0FDMUIsQ0FBQyxjQUFjLEVBQUUsaUJBQWlCLEVBQUUsU0FBUyxDQUFDLEVBQzlDLENBQUMsaUJBQWlCLEVBQUUsbUJBQW1CLEVBQUUsY0FBYyxDQUFDLENBQ3hEO0tBQ0QsQ0FBQztJQUVGLE1BQU0sbUJBQW1CLEdBQUcsa0JBQVEsQ0FBQyxNQUFNLENBQUMsbUJBQW1CLEVBQUUsWUFBWSxDQUFDLENBQUM7SUFDL0Usa0JBQUcsQ0FBQyxTQUFTLENBQUMsR0FBRyxVQUFVLGVBQWUsRUFBRSxJQUFJLENBQUMsS0FBSyxDQUFDLG1CQUFtQixDQUFDLEVBQUUsRUFBRSxNQUFNLEVBQUUsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUU1RixNQUFNLGVBQUssQ0FBQyxLQUFLLEVBQUUsQ0FBQyxTQUFTLENBQUMsRUFBRSxFQUFFLEdBQUcsRUFBRSxVQUFVLEVBQUUsQ0FBQyxDQUFDO0lBRXJELE9BQU8sQ0FBQyxJQUFJLEVBQUUsQ0FBQztJQUVmLE9BQU8sQ0FBQyxHQUFHLENBQUMsa0VBQWtFLElBQUksR0FBRyxDQUFDLENBQUM7SUFDdkYsT0FBTyxDQUFDLEdBQUcsQ0FBQyx1REFBdUQsQ0FBQyxDQUFDO0lBQ3JFLE1BQU0saUJBQWlCLEdBQUcsY0FBYyxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxPQUFPLElBQUksRUFBRSxDQUFDO0lBQy9FLE9BQU8sQ0FBQyxHQUFHLENBQUMsbUNBQW1DLGlCQUFpQixJQUFJLENBQUMsQ0FBQztJQUN0RSxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUMsQ0FBQyxDQUFDO0FBQ2pCLENBQUM7QUFFRCxnRUFBZ0U7QUFDaEUsU0FBUyxVQUFVLENBQUMsUUFBZ0I7SUFDbkMsT0FBTyxDQUFDLFFBQVEsQ0FBQyxRQUFRLENBQUMsVUFBVSxDQUFDLENBQUM7QUFDdkMsQ0FBQztBQUVEOzs7R0FHRztBQUNILFNBQVMsd0JBQXdCLENBQ2hDLElBQVMsRUFDVCxTQUErQztJQUUvQyxPQUFPLE1BQU0sQ0FBQyxXQUFXLENBQ3hCLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQyxHQUFHLEVBQUUsRUFBRSxDQUFDO1FBQ2pCLEdBQUc7UUFDSCxJQUFJLENBQUMsU0FBUyxDQUNiLFNBQVM7YUFDUCxHQUFHLENBQUMsQ0FBQyxRQUFRLEVBQUUsRUFBRSxDQUFDLFFBQVEsQ0FBQyxHQUFHLENBQUMsSUFBSSxFQUFFLENBQUM7YUFDdEMsTUFBTSxDQUFDLENBQUMsR0FBRyxFQUFFLElBQUksRUFBRSxFQUFFLENBQUMsQ0FBQyxFQUFFLEdBQUcsR0FBRyxFQUFFLEdBQUcsSUFBSSxFQUFFLENBQUMsRUFBRSxFQUFFLENBQUMsQ0FDbEQ7S0FDRCxDQUFDLENBQ0YsQ0FBQztBQUNILENBQUMifQ==

package/src/templates/common/.eslintignore

@@ -1,3 +0,0 @@
-node_modules
-dist
-.eslintrc.js

package/src/templates/common/.prettierignore

@@ -1,2 +0,0 @@
-dist
-node_modules

package/src/templates/common/.prettierrc.js

@@ -1,7 +0,0 @@
-module.exports = {
-	htmlWhitespaceSensitivity: 'ignore',
-	printWidth: 120,
-	singleQuote: true,
-	useTabs: true,
-	proseWrap: 'always',
-};

package/src/templates/javascript/common/.eslintrc.js

@@ -1,24 +0,0 @@
-module.exports = {
-	root: true,
-	env: {
-		node: true,
-	},
-	extends: ['plugin:prettier-vue/recommended', 'plugin:vue/essential'],
-	plugins: ['prettier'],
-	rules: {
-		'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
-		'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
-		'prettier/prettier': ['error', { singleQuote: true }],
-		'vue/valid-v-slot': 0,
-		'comma-dangle': [
-			'error',
-			{
-				arrays: 'always-multiline',
-				exports: 'always-multiline',
-				functions: 'never',
-				imports: 'always-multiline',
-				objects: 'always-multiline',
-			},
-		],
-	},
-};

package/src/templates/javascript/common/package.json.template

@@ -1,11 +0,0 @@
-{
-  "scripts": {
-
-  },
-  "dependencies": {
-
-	},
-	"devDependencies": {
-
-	}
-}

package/src/templates/javascript/common.vue/package.json.template

@@ -1,14 +0,0 @@
-{
-  "scripts": {
-    "build": "npx rollup -c"
-  },
-  "dependencies": {
-		"rollup": "latest",
-		"rollup-plugin-commonjs": "latest",
-		"rollup-plugin-node-resolve": "latest",
-		"rollup-plugin-terser": "latest",
-		"rollup-plugin-vue": "5.0.0",
-		"@vue/compiler-sfc": "latest",
-		"rollup-plugin-vue": "next"
-	}
-}

package/src/templates/javascript/common.vue/rollup.config.js

@@ -1,13 +0,0 @@
-import { terser } from 'rollup-plugin-terser';
-import resolve from 'rollup-plugin-node-resolve';
-import commonjs from 'rollup-plugin-commonjs';
-import vue from 'rollup-plugin-vue';
-
-export default {
-	input: 'src/index.js',
-	output: {
-		format: 'es',
-		file: 'dist/index.js',
-	},
-	plugins: [terser(), resolve(), commonjs(), vue()],
-};

package/src/templates/javascript/display/src/display.vue

@@ -1,7 +0,0 @@
-<template>
-	<div>My Custom Display</div>
-</template>
-
-<script>
-export default {};
-</script>

package/src/templates/javascript/display/src/index.js

@@ -1,10 +0,0 @@
-import DisplayComponent from './display.vue';
-
-export default {
-	id: 'custom',
-	name: 'Custom',
-	description: 'This is my custom display!',
-	icon: 'box',
-	handler: DisplayComponent,
-	types: ['string'],
-};

package/src/templates/javascript/endpoint/index.js

@@ -1,18 +0,0 @@
-module.exports = function registerEndpoint(router, { services, exceptions }) {
-	const { ItemsService } = services;
-	const { ServiceUnavailableException } = exceptions;
-
-	router.get('/', (req, res, next) => {
-		const recipeService = new ItemsService('recipes', {
-			schema: req.schema,
-			accountability: req.accountability,
-		});
-
-		recipeService
-			.readByQuery({ sort: 'name', fields: ['*'] })
-			.then((results) => res.json(results))
-			.catch((error) => {
-				return next(new ServiceUnavailableException(error.message));
-			});
-	});
-};

package/src/templates/javascript/hook/index.js

@@ -1,24 +0,0 @@
-module.exports = function registerHook({ services, exceptions }) {
-	const { ServiceUnavailableException, ForbiddenException } = exceptions;
-
-	return {
-		// Force everything to be admin-only at all times
-		'items.*': async function ({ item, accountability }) {
-			if (accountability.admin !== true) throw new ForbiddenException();
-		},
-		// Sync with external recipes service, cancel creation on failure
-		'items.create.before': async function (input, { collection }) {
-			if (collection !== 'recipes') return input;
-
-			try {
-				await axios.post('https://example.com/recipes', input);
-			} catch (error) {
-				throw new ServiceUnavailableException(error);
-			}
-
-			input[0].syncedWithExample = true;
-
-			return input;
-		},
-	};
-};

package/src/templates/javascript/interface/src/index.js

@@ -1,10 +0,0 @@
-import InterfaceComponent from './interface.vue';
-
-export default {
-	id: 'custom',
-	name: 'Custom',
-	description: 'This is my custom interface!',
-	icon: 'box',
-	component: InterfaceComponent,
-	types: ['string'],
-};

package/src/templates/javascript/interface/src/interface.vue

@@ -1,16 +0,0 @@
-<template>
-	<input :value="value" @input="handleChange($event.target.value)" />
-</template>
-
-<script>
-export default {
-	props: {
-		value: String,
-	},
-	methods: {
-		handleChange(value) {
-			this.$emit('input', value);
-		},
-	},
-};
-</script>

package/src/templates/javascript/layout/src/index.js

@@ -1,7 +0,0 @@
-import LayoutComponent from './layout.vue';
-
-export default {
-	id: 'custom',
-	name: 'Custom',
-	component: LayoutComponent,
-};

package/src/templates/javascript/layout/src/layout.vue

@@ -1,35 +0,0 @@
-<template>
-  <div>
-    <div>Collection: {{ collection }}</div>
-    <v-list>
-      <v-list-item v-for="item in items" v-bind:key="item.id">
-        {{item}}
-      </v-list-item>
-    </v-list>
-    <v-button v-on:click="logToConsole">Log items to console</v-button>
-  </div>
-</template>
-<script>
-  export default {
-    data() {
-      return {
-        items: null,
-      };
-    },
-    methods: {
-      logToConsole: function () {
-        console.log(this.items);
-      },
-    },
-    inject: ["system"],
-    mounted() {
-      // log the system field so you can see what attributes are available under it
-      // remove this line when you're done.
-      console.log(this.system);
-      // Get a list of all available collections to use with this module
-      this.system.api.get(`/items/${this.collection}`).then((res) => {
-        this.items = res;
-      });
-    },
-  };
-</script>

package/src/templates/javascript/module/src/index.js

@@ -1,13 +0,0 @@
-import ModuleComponent from './module.vue';
-
-export default {
-	id: 'custom',
-	name: 'Custom',
-	icon: 'box',
-	routes: [
-		{
-			path: '/',
-			component: ModuleComponent,
-		},
-	],
-};

package/src/templates/javascript/module/src/module.vue

@@ -1,36 +0,0 @@
-<template>
-  <private-view title="Example Collection List">
-    <v-list>
-      <v-list-item v-for="col in collections" v-bind:key="col.collection">
-        {{col.collection}}
-      </v-list-item>
-    </v-list>
-    <v-button v-on:click="logToConsole">Log collections to console</v-button>
-  </private-view>
-</template>
-
-<script>
-  export default {
-    data() {
-      return {
-        collections: null,
-      };
-    },
-    methods: {
-      logToConsole: function () {
-        console.log(this.collections);
-      },
-    },
-    inject: ["system"],
-    mounted() {
-      // log the system field so you can see what attributes are available under it
-      // remove this line when you're done.
-      console.log(this.system);
-
-      // Get a list of all available collections to use with this module
-      this.system.api.get("/collections?limit=-1").then((res) => {
-        this.collections = res.data.data;
-      });
-    },
-  };
-</script>

package/src/templates/package.json.mustache

@@ -1,16 +0,0 @@
-{
-  "name": "{{ name }}",
-  "version": "1.0.0",
-  "description": "",
-  "main": "",
-  "scripts": {{{ scripts }}},
-  "keywords": [
-    "directus",
-    "directus-extension",
-    "directus-custom-{{ type }}"
-  ],
-  "author": "",
-  "license": "GPL-3.0",
-  "dependencies": {{{ dependencies }}},
-  "devDependencies": {{{ devDependencies }}}
-}

package/src/templates/typescript/common/.eslintrc.js

@@ -1,36 +0,0 @@
-module.exports = {
-	root: true,
-	env: {
-		node: true,
-	},
-	extends: [
-		'plugin:@typescript-eslint/recommended',
-		'plugin:prettier-vue/recommended',
-		'plugin:vue/essential',
-	],
-	plugins: ['@typescript-eslint', 'prettier'],
-	rules: {
-		'no-console': process.env.NODE_ENV === 'production' ? 'error' : 'off',
-		'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
-		'@typescript-eslint/camelcase': 0,
-		'@typescript-eslint/no-use-before-define': 0,
-		'@typescript-eslint/ban-ts-ignore': 0,
-		'@typescript-eslint/no-explicit-any': 0,
-		'@typescript-eslint/no-var-requires': 0,
-		'prettier/prettier': ['error', { singleQuote: true }],
-		'vue/valid-v-slot': 0,
-		'comma-dangle': [
-			'error',
-			{
-				arrays: 'always-multiline',
-				exports: 'always-multiline',
-				functions: 'never',
-				imports: 'always-multiline',
-				objects: 'always-multiline',
-			},
-		],
-	},
-	parserOptions: {
-		parser: '@typescript-eslint/parser',
-	},
-};

package/src/templates/typescript/common/package.json.template

@@ -1,20 +0,0 @@
-{
-  "scripts": {
-    "build": "tsc",
-    "build:watch": "tsc -w --preserveWatchOutput"
-  },
-  "dependencies": {
-  },
-  "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.9.1",
-		"@typescript-eslint/parser": "^4.9.1",
-    "directus": "latest",
-    "typescript": "^4.0.5",
-		"eslint": "^7.22.0",
-    "eslint-config-prettier": "^8.1.0",
-		"eslint-plugin-prettier": "^3.3.1",
-		"eslint-plugin-prettier-vue": "^2.1.1",
-		"eslint-plugin-vue": "^7.8.0",
-    "prettier": "^2.2.1"
-  }
-}

package/src/templates/typescript/common/tsconfig.json

@@ -1,21 +0,0 @@
-{
-	"compilerOptions": {
-		"target": "esnext",
-		"module": "commonjs",
-		"rootDir": "./",
-		"outDir": "dist",
-		"strict": true,
-		"esModuleInterop": true,
-		"inlineSourceMap": true,
-		"skipLibCheck": true,
-		"forceConsistentCasingInFileNames": true,
-		"resolveJsonModule": true,
-	},
-	"include": [
-		"src/**/*.ts"
-	],
-	"exclude": [
-		"node_modules",
-		"src/templates"
-	]
-}

package/src/templates/typescript/common.vue/package.json.template

@@ -1,14 +0,0 @@
-{
-  "scripts": {
-    "build": "npx rollup -c"
-  },
-  "dependencies": {
-		"rollup": "latest",
-		"rollup-plugin-commonjs": "latest",
-		"rollup-plugin-node-resolve": "latest",
-		"rollup-plugin-terser": "latest",
-		"rollup-plugin-vue": "5.0.0",
-		"@vue/compiler-sfc": "latest",
-		"rollup-plugin-vue": "next"
-	}
-}

package/src/templates/typescript/endpoint/package.json.template

@@ -1,5 +0,0 @@
-{
-  "devDependencies": {
-    "@types/express": "^4.17.11"
-  }
-}

package/src/templates/typescript/endpoint/src/index.ts

@@ -1,26 +0,0 @@
-import { EndpointRegisterFunction } from './types';
-
-const registerEndpoint: EndpointRegisterFunction = (router, { services, exceptions }) => {
-	const { ItemsService } = services;
-	const { ServiceUnavailableException } = exceptions;
-
-	router.get('/', (req, res, next) => {
-		const recipeService = new ItemsService('recipes', {
-			schema: req.schema,
-			accountability: req.accountability,
-		});
-
-		recipeService
-			.readByQuery({ sort: [{ column: 'name', order: 'asc' }], fields: ['*'] })
-			.then((results) => res.json(results))
-			.catch((error) => {
-				return next(
-					new ServiceUnavailableException(error.message, {
-						service: 'my-custom-service',
-					}),
-				);
-			});
-	});
-};
-
-export default registerEndpoint;

package/src/templates/typescript/endpoint/src/types.d.ts

@@ -1,18 +0,0 @@
-import { Accountability, Query, SchemaOverview } from 'directus/dist/types';
-import { EndpointRegisterFunction } from 'directus/dist/types/extensions';
-
-declare global {
-	namespace Express {
-		export interface Request {
-			token: string | null;
-			collection: string;
-			sanitizedQuery: Query;
-			schema: SchemaOverview;
-
-			accountability?: Accountability;
-			singleton?: boolean;
-		}
-	}
-}
-
-export { EndpointRegisterFunction };

package/src/templates/typescript/hook/package.json.template

@@ -1,6 +0,0 @@
-{
-  "devDependencies": {
-    "axios": "^0.21.0",
-    "knex": "^0.95.3"
-  }
-}

package/src/templates/typescript/hook/src/index.ts

@@ -1,31 +0,0 @@
-import { HookRegisterFunction, EventHandlerArguments } from './types';
-import axios from 'axios';
-
-const registerHook: HookRegisterFunction = ({ services, exceptions }) => {
-	const { ServiceUnavailableException, ForbiddenException } = exceptions;
-
-	return {
-		// Force everything to be admin-only at all times
-		'items.*': async function ({ item, accountability }: EventHandlerArguments) {
-			if (accountability.admin !== true) throw new ForbiddenException();
-		},
-		// Sync with external recipes service, cancel creation on failure
-		'items.create.before': async function (input, { collection }) {
-			if (collection !== 'recipes') return input;
-
-			try {
-				await axios.post('https://example.com/recipes', input);
-			} catch (error) {
-				throw new ServiceUnavailableException(error, {
-					service: 'my-custom-extension',
-				});
-			}
-
-			input[0].syncedWithExample = true;
-
-			return input;
-		},
-	};
-};
-
-export default registerHook;

package/src/templates/typescript/hook/src/types.d.ts

@@ -1,18 +0,0 @@
-import { HookRegisterFunction, ExtensionContext } from 'directus/dist/types/extensions';
-import { Accountability } from 'directus/dist/types/accountability';
-import { SchemaOverview } from 'directus/dist/types/schema';
-
-declare type Action = 'create' | 'update' | 'delete';
-
-declare type EventHandlerArguments = {
-	event: string;
-	accountability: Accountability;
-	collection: string;
-	item: string;
-	action: Action;
-	payload: unknown;
-	schema: SchemaOverview;
-	database: ExtensionContext['database'];
-};
-
-export { HookRegisterFunction, EventHandlerArguments };