jack zhang 705b7449f0
feat: new plugin manager, supports adding plugins through UI (#2430)
* refactor: plugin manager page

* fix: bug

* feat: addByNpm api

* fix: improve the addByNpm

* feat: improve applicationPlugins:list api

* fix: re-download npm package when restart app

* fix: plugin delete api

* feat: plugin detail api

* feat: zipUrl add api

* fix: upload api bug

* fix: plugin detail info

* feat: upgrade api

* fix: upload api

* feat: handle plugin load error

* feat: support authToken

* feat: muti lang

* fix: build error

* fix: self review

* Update plugin-manager.ts

* fix: bug

* fix: bug

* fix: bug

* fix: bug

* fix: bug

* fix: bugs

* fix: detail click and remove isOfficial

* fix: upgrade no refresh

* fix: file size and type check

* fix: bug

* fix: upgrade error

* fix: bug

* fix: bug

* fix: plugin card layout

* fix: handling exceptional cases

* fix: tgz file support

* fix: macos compress file

* fix: bug

* fix: bug

* fix: bug

* fix: bug

* fix: add upgrade npm type

* fix: bugs

* fix: bug

* fix: change plugins static expose url

* fix: api prefix

* fix: bug

* fix: add nginx `/static/plugin/` path

* fix: bugs and pr docker build no dts

* fix: bug

* fix: build tools bug

* fix: improve code

* fix: build bug

* feat: improve plugin info

* fix: ui bug

* fix: plugin document bug

* feat: improve code

* feat: improve code

* feat: process dev deps check

* feat: improve code

* feat: process.env.IS_DEV_CMD

* fix: do not delete the plugin package

* feat: plugin symlink

* fix: tsx watch --ignore=./storage/plugins/**

* fix: test error

* fix: improve code

* fix: improve code

* fix: emitStartedEvent

* fix: improve code

* fix: type error

* fix: test error

* test: console.log

* fix: createStoragePluginSymLink

* fix: clientStaticMiddleware rename to clientStaticUtils

* feat: build tools support plugins folder

* fix: 350px

* fix: error

* feat: client dev support plugin folder

* fix: clear cli options

* fix: typeError: Converting circular structure to JSON

* fix: plugin name

* chore: restart application after command

* feat: upgrade error & docs

* Update v14-changelog.md

* Update v14-changelog.md

* Update v14-changelog.md

* fix: gateway test

* refactor(plugin-workflow): add ready state for gracefully tearing down

* Revert "chore: restart application after command"

This reverts commit 5015274f8e4e06e506e15754b672330330e8c7f8.

* chore: stop application whe restart

* T 1218 change plugin folder (#2629)

* feat: change folder name

* feat: change `pm create` command

* feat:  revert plugin name change

* fix: delete samples

* feat: change plugins folder

* fix: pm create

* feat: update docs

* fix: link package error

* fix: docs

* fix: create command

* fix: pm add error

* fix: create  add build

* fix: pm creatre + add

* feat: add tar command

* fix: docs

* fix: bug

* fix: docs

---------

Co-authored-by: chenos <chenlinxh@gmail.com>

* feat: docs

* Update your-fisrt-plugin.md

* Update your-fisrt-plugin.md

* chore: application reload

* chore: test

* fix: pm add error

* chore: preset install skip exists plugin

* fix: createIfNotExists

---------

Co-authored-by: chenos <chenlinxh@gmail.com>
Co-authored-by: chareice <chareice@live.com>
Co-authored-by: Zhou <zhou.working@gmail.com>
Co-authored-by: mytharcher <mytharcher@gmail.com>
2023-09-12 22:39:23 +08:00

77 lines
2.5 KiB
TypeScript

import fs from 'fs';
import path from 'path';
export const PLUGIN_STATICS_PATH = '/static/plugins/';
/**
* get package.json path for specific NPM package
*/
export function getDepPkgPath(packageName: string, cwd?: string) {
try {
return require.resolve(`${packageName}/package.json`, { paths: cwd ? [cwd] : undefined });
} catch {
const mainFile = require.resolve(`${packageName}`, { paths: cwd ? [cwd] : undefined });
const packageDir = mainFile.slice(0, mainFile.indexOf(packageName.replace('/', path.sep)) + packageName.length);
return path.join(packageDir, 'package.json');
}
}
export function getPackageDir(packageName: string) {
const packageJsonPath = getDepPkgPath(packageName);
return path.dirname(packageJsonPath);
}
export function getPackageFilePath(packageName: string, filePath: string) {
const packageDir = getPackageDir(packageName);
return path.join(packageDir, filePath);
}
export function getPackageFilePathWithExistCheck(packageName: string, filePath: string) {
const absolutePath = getPackageFilePath(packageName, filePath);
const exists = fs.existsSync(absolutePath);
return {
filePath: absolutePath,
exists,
};
}
export function getExposeUrl(packageName: string, filePath: string) {
return `${PLUGIN_STATICS_PATH}${packageName}/${filePath}`;
}
export function getExposeReadmeUrl(packageName: string, lang: string) {
let READMEPath = null;
if (getPackageFilePathWithExistCheck(packageName, `README.${lang}.md`).exists) {
READMEPath = `README.${lang}.md`;
} else if (getPackageFilePathWithExistCheck(packageName, 'README.md').exists) {
READMEPath = 'README.md';
}
return READMEPath ? getExposeUrl(packageName, READMEPath) : null;
}
export function getExposeChangelogUrl(packageName: string) {
const { exists } = getPackageFilePathWithExistCheck(packageName, 'CHANGELOG.md');
return exists ? getExposeUrl(packageName, 'CHANGELOG.md') : null;
}
/**
* get package name by client static url
*
* @example
* getPluginNameByClientStaticUrl('/static/plugins/dayjs/index.js') => 'dayjs'
* getPluginNameByClientStaticUrl('/static/plugins/@nocobase/foo/README.md') => '@nocobase/foo'
*/
export function getPackageNameByExposeUrl(pathname: string) {
pathname = pathname.replace(PLUGIN_STATICS_PATH, '');
const pathArr = pathname.split('/');
if (pathname.startsWith('@')) {
return pathArr.slice(0, 2).join('/');
}
return pathArr[0];
}
export function getPackageDirByExposeUrl(pathname: string) {
return getPackageDir(getPackageNameByExposeUrl(pathname));
}