Rename extension-sdk to extensions-sdk (#7282)

While it is never nice to rename an already published package,
this allows us to reserve the "@directus/extension-" prefix for official extensions.
This commit is contained in:
Nicola Krumschmidt
2021-08-27 19:48:19 +02:00
committed by GitHub
parent 5378926cf3
commit d2ca0d094c
37 changed files with 59 additions and 26 deletions

2
.github/CODEOWNERS vendored
View File

@@ -3,6 +3,6 @@
/docs/*.md @benhaynes
/packages/shared @nickrum
/packages/extension-sdk @nickrum
/packages/extensions-sdk @nickrum
/packages/create-directus-extension @nickrum
/app/vite.config.js @nickrum

View File

@@ -28,7 +28,7 @@
"gitHead": "24621f3934dc77eb23441331040ed13c676ceffd",
"devDependencies": {
"@directus/docs": "9.0.0-rc.91",
"@directus/extension-sdk": "9.0.0-rc.91",
"@directus/extensions-sdk": "9.0.0-rc.91",
"@directus/format-title": "9.0.0-rc.91",
"@directus/shared": "9.0.0-rc.91",
"@fullcalendar/core": "5.9.0",

View File

@@ -95,12 +95,12 @@ npm init -y
```
To be read by the Admin App, your custom display's Vue component must first be bundled into a single `index.js` file. We
recommend bundling your code using the directus-extension CLI from our `@directus/extension-sdk` package. The CLI
recommend bundling your code using the directus-extension CLI from our `@directus/extensions-sdk` package. The CLI
internally uses a Rollup configuration tailored specifically to bundling Directus extensions. To install the Extension
SDK, run this command:
```bash
npm i -D @directus/extension-sdk
npm i -D @directus/extensions-sdk
```
For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to

View File

@@ -86,12 +86,12 @@ npm init -y
```
To be read by the Admin App, your custom interface's Vue component must first be bundled into a single `index.js` file.
We recommend bundling your code using the directus-extension CLI from our `@directus/extension-sdk` package. The CLI
We recommend bundling your code using the directus-extension CLI from our `@directus/extensions-sdk` package. The CLI
internally uses a Rollup configuration tailored specifically to bundling Directus extensions. To install the Extension
SDK, run this command:
```bash
npm i -D @directus/extension-sdk
npm i -D @directus/extensions-sdk
```
For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to

View File

@@ -60,7 +60,7 @@ for more info on what can go into this object.
<script>
import { toRefs } from 'vue';
import { useLayoutState } from '@directus/extension-sdk';
import { useLayoutState } from '@directus/extensions-sdk';
export default {
setup() {
@@ -91,12 +91,12 @@ npm init -y
```
To be read by the Admin App, your custom layouts's Vue component must first be bundled into a single `index.js` file. We
recommend bundling your code using the directus-extension CLI from our `@directus/extension-sdk` package. The CLI
recommend bundling your code using the directus-extension CLI from our `@directus/extensions-sdk` package. The CLI
internally uses a Rollup configuration tailored specifically to bundling Directus extensions. To install the Extension
SDK, run this command:
```bash
npm i -D @directus/extension-sdk
npm i -D @directus/extensions-sdk
```
For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to

View File

@@ -128,12 +128,12 @@ npm init -y
```
To be read by the Admin App, your custom module's Vue component must first be bundled into a single `index.js` file. We
recommend bundling your code using the directus-extension CLI from our `@directus/extension-sdk` package. The CLI
recommend bundling your code using the directus-extension CLI from our `@directus/extensions-sdk` package. The CLI
internally uses a Rollup configuration tailored specifically to bundling Directus extensions. To install the Extension
SDK, run this command:
```bash
npm i -D @directus/extension-sdk
npm i -D @directus/extensions-sdk
```
For the directus-extension CLI to recognize the extension type, the input path and the output path, add this field to

49
package-lock.json generated
View File

@@ -200,7 +200,7 @@
"version": "9.0.0-rc.91",
"devDependencies": {
"@directus/docs": "9.0.0-rc.91",
"@directus/extension-sdk": "9.0.0-rc.91",
"@directus/extensions-sdk": "9.0.0-rc.91",
"@directus/format-title": "9.0.0-rc.91",
"@directus/shared": "9.0.0-rc.91",
"@fullcalendar/core": "5.9.0",
@@ -2827,8 +2827,8 @@
"resolved": "packages/drive-s3",
"link": true
},
"node_modules/@directus/extension-sdk": {
"resolved": "packages/extension-sdk",
"node_modules/@directus/extensions-sdk": {
"resolved": "packages/extensions-sdk",
"link": true
},
"node_modules/@directus/format-title": {
@@ -51006,7 +51006,7 @@
"version": "9.0.0-rc.91",
"license": "GPL-3.0-only",
"dependencies": {
"@directus/extension-sdk": "9.0.0-rc.91",
"@directus/extensions-sdk": "9.0.0-rc.91",
"@directus/shared": "9.0.0-rc.91",
"inquirer": "^8.1.2"
},
@@ -51120,6 +51120,39 @@
"packages/extension-sdk": {
"name": "@directus/extension-sdk",
"version": "9.0.0-rc.91",
"extraneous": true,
"dependencies": {
"@directus/shared": "9.0.0-rc.91",
"@rollup/plugin-commonjs": "^20.0.0",
"@rollup/plugin-json": "^4.1.0",
"@rollup/plugin-node-resolve": "^13.0.0",
"@rollup/plugin-replace": "^3.0.0",
"@vue/compiler-sfc": "^3.1.1",
"chalk": "^4.1.1",
"commander": "^8.0.0",
"execa": "^5.1.1",
"fs-extra": "^10.0.0",
"ora": "^5.4.0",
"rollup": "^2.51.2",
"rollup-plugin-styles": "^3.14.1",
"rollup-plugin-terser": "^7.0.2",
"rollup-plugin-vue": "^6.0.0"
},
"bin": {
"directus-extension": "cli.js"
},
"devDependencies": {
"npm-run-all": "4.1.5",
"rimraf": "3.0.2",
"typescript": "4.4.2"
},
"engines": {
"node": ">=12.20.0"
}
},
"packages/extensions-sdk": {
"name": "@directus/extensions-sdk",
"version": "9.0.0-rc.91",
"dependencies": {
"@directus/shared": "9.0.0-rc.91",
"@rollup/plugin-commonjs": "^20.0.0",
@@ -52965,7 +52998,7 @@
"version": "file:app",
"requires": {
"@directus/docs": "9.0.0-rc.91",
"@directus/extension-sdk": "9.0.0-rc.91",
"@directus/extensions-sdk": "9.0.0-rc.91",
"@directus/format-title": "9.0.0-rc.91",
"@directus/shared": "9.0.0-rc.91",
"@fullcalendar/core": "5.9.0",
@@ -53280,8 +53313,8 @@
"typescript": "4.4.2"
}
},
"@directus/extension-sdk": {
"version": "file:packages/extension-sdk",
"@directus/extensions-sdk": {
"version": "file:packages/extensions-sdk",
"requires": {
"@directus/shared": "9.0.0-rc.91",
"@rollup/plugin-commonjs": "^20.0.0",
@@ -64359,7 +64392,7 @@
"create-directus-extension": {
"version": "file:packages/create-directus-extension",
"requires": {
"@directus/extension-sdk": "9.0.0-rc.91",
"@directus/extensions-sdk": "9.0.0-rc.91",
"@directus/shared": "9.0.0-rc.91",
"inquirer": "^8.1.2"
}

View File

@@ -3,7 +3,7 @@
const inquirer = require('inquirer');
const { EXTENSION_TYPES } = require('@directus/shared/constants');
const { create } = require('@directus/extension-sdk/cli');
const { create } = require('@directus/extensions-sdk/cli');
run();

View File

@@ -19,7 +19,7 @@
"license": "GPL-3.0-only",
"gitHead": "24621f3934dc77eb23441331040ed13c676ceffd",
"dependencies": {
"@directus/extension-sdk": "9.0.0-rc.91",
"@directus/extensions-sdk": "9.0.0-rc.91",
"@directus/shared": "9.0.0-rc.91",
"inquirer": "^8.1.2"
}

View File

@@ -1,5 +1,5 @@
{
"name": "@directus/extension-sdk",
"name": "@directus/extensions-sdk",
"version": "9.0.0-rc.91",
"description": "A toolkit to develop extensions to extend Directus.",
"main": "dist/cjs/index.js",

View File

@@ -1,3 +1,3 @@
# @directus/extension-sdk
# @directus/extensions-sdk
A toolkit to develop extensions to extend Directus.

View File

@@ -64,7 +64,7 @@ export default async function create(type: string, name: string): Promise<void>
build: 'directus-extension build',
},
devDependencies: {
'@directus/extension-sdk': pkg.version,
'@directus/extensions-sdk': pkg.version,
},
};

View File

@@ -4,7 +4,7 @@
<script>
import { toRefs } from 'vue';
import { useLayoutState } from '@directus/extension-sdk';
import { useLayoutState } from '@directus/extensions-sdk';
export default {
setup() {

View File

@@ -1,4 +1,4 @@
export const APP_SHARED_DEPS = ['@directus/extension-sdk', 'vue', 'vue-router'];
export const APP_SHARED_DEPS = ['@directus/extensions-sdk', 'vue', 'vue-router'];
export const API_SHARED_DEPS = ['axios'];
export const APP_EXTENSION_TYPES = ['interface', 'display', 'layout', 'module'] as const;