self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2025-06-24 23:26:50 +02:00
Code Issues Releases Activity

Plugins: Updated types

Browse Source
This commit is contained in:
Laurent Cozic
2021-01-13 12:17:54 +00:00
parent 3abf21d4ae
commit 4743b0b5ce
91 changed files with 1062 additions and 434 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
packages/app-cli/tests/support/plugins/codemirror_content_script/.npmignore
View File

@ -6,8 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/codemirror_content_script/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/codemirror_content_script/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/codemirror_content_script/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,6 +22,7 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/codemirror_content_script/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/content_script/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/content_script/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/content_script/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/content_script/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/content_script/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,7 +22,8 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
}, },
"dependencies": { "dependencies": {
"left-pad": "^1.3.0" "left-pad": "^1.3.0"

72
packages/app-cli/tests/support/plugins/content_script/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/dialog/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/dialog/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/dialog/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/dialog/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/dialog/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,6 +22,7 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/dialog/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/editor_context_menu/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/editor_context_menu/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/editor_context_menu/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/editor_context_menu/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/editor_context_menu/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,6 +22,7 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/editor_context_menu/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/events/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/events/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/events/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/events/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/events/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,6 +22,7 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/events/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/jpl_test/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/jpl_test/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/jpl_test/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/jpl_test/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/jpl_test/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,6 +22,7 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/jpl_test/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/json_export/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/json_export/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/json_export/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/json_export/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/json_export/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,6 +22,7 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/json_export/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/menu/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/menu/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/menu/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/menu/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/menu/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,6 +22,7 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/menu/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/multi_selection/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/multi_selection/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/multi_selection/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/multi_selection/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/multi_selection/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,6 +22,7 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/multi_selection/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

3
packages/app-cli/tests/support/plugins/post_messages/.gitignore vendored
View File

@ -1,6 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

3
packages/app-cli/tests/support/plugins/post_messages/.npmignore
View File

@ -6,6 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/post_messages/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/post_messages/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/post_messages/package.json
View File

@ -2,7 +2,7 @@
"name": "joplin-plugin-postmessage-demo", "name": "joplin-plugin-postmessage-demo",
"version": "1.0.0", "version": "1.0.0",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -21,6 +21,7 @@
"ts-loader": "^7.0.5", "ts-loader": "^7.0.5",
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11" "webpack-cli": "^3.3.11",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/post_messages/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/register_command/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/register_command/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/register_command/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/register_command/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/register_command/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,6 +22,7 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/register_command/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/selected_text/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/selected_text/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/selected_text/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/selected_text/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/selected_text/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,6 +22,7 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/selected_text/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/settings/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/settings/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/settings/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/settings/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/settings/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,6 +22,7 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
} }
} }

72
packages/app-cli/tests/support/plugins/settings/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/toc/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/toc/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/toc/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/toc/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

7
packages/app-cli/tests/support/plugins/toc/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,9 +22,10 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
}, },
"dependencies": { "dependencies": {
"uslug": "^1.0.4" "uslug": "^1.0.4"
} }
} }

72
packages/app-cli/tests/support/plugins/toc/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

4
packages/app-cli/tests/support/plugins/withExternalModules/.gitignore vendored
View File

@ -1,7 +1,3 @@
dist/ dist/
node_modules/ node_modules/
publish/ publish/

4
packages/app-cli/tests/support/plugins/withExternalModules/.npmignore
View File

@ -6,7 +6,3 @@
/dist /dist
tsconfig.json tsconfig.json
webpack.config.js webpack.config.js

10
packages/app-cli/tests/support/plugins/withExternalModules/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/app-cli/tests/support/plugins/withExternalModules/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *

5
packages/app-cli/tests/support/plugins/withExternalModules/package.json
View File

@ -3,7 +3,7 @@
"version": "1.0.0", "version": "1.0.0",
"description": "", "description": "",
"scripts": { "scripts": {
"dist": "webpack", "dist": "webpack --joplin-plugin-config buildMain && webpack --joplin-plugin-config buildExtraScripts && webpack --joplin-plugin-config createArchive",
"prepare": "npm run dist", "prepare": "npm run dist",
"update": "npm install -g generator-joplin && yo joplin --update" "update": "npm install -g generator-joplin && yo joplin --update"
}, },
@ -22,7 +22,8 @@
"typescript": "^3.9.3", "typescript": "^3.9.3",
"webpack": "^4.43.0", "webpack": "^4.43.0",
"webpack-cli": "^3.3.11", "webpack-cli": "^3.3.11",
"chalk": "^4.1.0" "chalk": "^4.1.0",
"yargs": "^16.2.0"
}, },
"dependencies": { "dependencies": {
"left-pad": "^1.3.0" "left-pad": "^1.3.0"

72
packages/app-cli/tests/support/plugins/withExternalModules/webpack.config.js
View File

@ -33,10 +33,6 @@ const manifest = readManifest(manifestPath);
const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`); const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`); const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
function validatePackageJson() { function validatePackageJson() {
const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8')); const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) { if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
@ -109,6 +105,7 @@ function createPluginInfo(manifestPath, destPath, jplFilePath) {
function onBuildCompleted() { function onBuildCompleted() {
try { try {
fs.removeSync(path.resolve(publishDir, 'index.js'));
createPluginArchive(distDir, pluginArchiveFilePath); createPluginArchive(distDir, pluginArchiveFilePath);
createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath); createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
validatePackageJson(); validatePackageJson();
@ -174,6 +171,16 @@ const extraScriptConfig = Object.assign({}, baseConfig, {
}, },
}); });
const createArchiveConfig = {
stats: 'errors-only',
entry: './dist/index.js',
output: {
filename: 'index.js',
path: publishDir,
},
plugins: [new WebpackOnBuildPlugin(onBuildCompleted)],
};
function resolveExtraScriptPath(name) { function resolveExtraScriptPath(name) {
const relativePath = `./src/${name}`; const relativePath = `./src/${name}`;
@ -196,8 +203,8 @@ function resolveExtraScriptPath(name) {
}; };
} }
function addExtraScriptConfigs(baseConfig, userConfig) { function buildExtraScriptConfigs(userConfig) {
if (!userConfig.extraScripts.length) return baseConfig; if (!userConfig.extraScripts.length) return [];
const output = []; const output = [];
@ -209,22 +216,55 @@ function addExtraScriptConfigs(baseConfig, userConfig) {
})); }));
} }
return baseConfig.concat(output); return output;
} }
function addLastConfigStep(config) { function main(processArgv) {
const lastConfig = config[config.length - 1]; const yargs = require('yargs/yargs');
if (!lastConfig.plugins) lastConfig.plugins = []; const argv = yargs(processArgv).argv;
lastConfig.plugins.push(new WebpackOnBuildPlugin(onBuildCompleted));
config[config.length - 1] = lastConfig; const configName = argv['joplin-plugin-config'];
return config; if (!configName) throw new Error('A config file must be specified via the --joplin-plugin-config flag');
// Webpack configurations run in parallel, while we need them to run in
// sequence, and to do that it seems the only way is to run webpack multiple
// times, with different config each time.
const configs = {
// Builds the main src/index.ts and copy the extra content from /src to
// /dist including scripts, CSS and any other asset.
buildMain: pluginConfig,
// Builds the extra scripts as defined in plugin.config.json. When doing
// so, some JavaScript files that were copied in the previous might be
// overwritten here by the compiled version. This is by design. The
// result is that JS files that don't need compilation, are simply
// copied to /dist, while those that do need it are correctly compiled.
buildExtraScripts: buildExtraScriptConfigs(userConfig),
// Ths config is for creating the .jpl, which is done via the plugin, so
// it doesn't actually need an entry and output, however webpack won't
// run without this. So we give it an entry that we know is going to
// exist and output in the publish dir. Then the plugin will delete this
// temporary file before packaging the plugin.
createArchive: createArchiveConfig,
};
// If we are running the first config step, we clean up and create the build
// directories.
if (configName === 'buildMain') {
fs.removeSync(distDir);
fs.removeSync(publishDir);
fs.mkdirpSync(publishDir);
}
return configs[configName];
} }
let exportedConfigs = [pluginConfig]; let exportedConfigs = [];
try { try {
exportedConfigs = addExtraScriptConfigs(exportedConfigs, userConfig); exportedConfigs = main(process.argv);
exportedConfigs = addLastConfigStep(exportedConfigs);
} catch (error) { } catch (error) {
console.error(chalk.red(error.message)); console.error(chalk.red(error.message));
process.exit(1); process.exit(1);

10
packages/generator-joplin/generators/app/templates/api/JoplinContentScripts.d.ts vendored
View File

@ -23,10 +23,18 @@ export default class JoplinContentScripts {
* * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script) * * [View the renderer demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/content_script)
* * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script) * * [View the editor demo plugin](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/codemirror_content_script)
* *
* See also the [postMessage demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*
* @param type Defines how the script will be used. See the type definition for more information about each supported type. * @param type Defines how the script will be used. See the type definition for more information about each supported type.
* @param id A unique ID for the content script. * @param id A unique ID for the content script.
* @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`. * @param scriptPath Must be a path relative to the plugin main script. For example, if your file content_script.js is next to your index.ts file, you would set `scriptPath` to `"./content_script.js`.
*/ */
register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>; register(type: ContentScriptType, id: string, scriptPath: string): Promise<void>;
onMessage(id: string, callback: any): Promise<void>; /**
* Listens to a messages sent from the content script using postMessage().
* See {@link ContentScriptType} for more information as well as the
* [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages)
*/
onMessage(contentScriptId: string, callback: any): Promise<void>;
} }

4
packages/generator-joplin/generators/app/templates/api/types.ts
View File

@ -458,7 +458,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *
@ -557,7 +557,7 @@ export enum ContentScriptType {
* }); * });
* ``` * ```
* *
* See {@link JoplinContentScript.onMessage} for more details, as well as * See {@link JoplinContentScripts.onMessage} for more details, as well as
* the [postMessage * the [postMessage
* demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages). * demo](https://github.com/laurent22/joplin/tree/dev/packages/app-cli/tests/support/plugins/post_messages).
* *