Generator: Update plugin generator to handle requirements of coming plugin repository

packages/generator-joplin/README.md

@@ -37,6 +37,16 @@ To build the plugin, simply run `npm run dist`.
 
 The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
 
+## Publishing the plugin
+
+To publish the plugin, add it to npmjs.com by running `npm publish`. Later on, a script will pick up your plugin and add it automatically to the Joplin plugin repository as long as the package satisfies these conditions:
+
+- In `package.json`, the name starts with "joplin-plugin-". For example, "joplin-plugin-toc".
+- In `package.json`, the keywords include "joplin-plugin".
+- In the `publish/` directory, there should be a .jpl and .json file (which are built by `npm run dist`)
+
+In general all this is done automatically by the plugin generator, which will set the name and keywords of package.json, and will put the right files in the "publish" directory. But if something doesn't work and your plugin doesn't appear in the repository, double-check the above conditions.
+
 ## Updating the plugin framework
 
 To update the plugin framework, run `yo joplin --update`

packages/generator-joplin/generators/app/index.js

@@ -3,6 +3,7 @@
 const Generator = require('yeoman-generator');
 const chalk = require('chalk');
 const yosay = require('yosay');
+const slugify = require('slugify');
 
 function mergePackageKey(parentKey, source, dest) {
 	const output = Object.assign({}, dest);
@@ -27,6 +28,18 @@ function mergePackageKey(parentKey, source, dest) {
 	return output;
 }
 
+function packageNameFromPluginName(pluginName) {
+	return `joplin-plugin-${slugify(pluginName, {
+		lower: true,
+	})}`;
+}
+
+function addDerivedProps(props) {
+	return Object.assign({}, props, {
+		packageName: packageNameFromPluginName(props.pluginName),
+	});
+}
+
 module.exports = class extends Generator {
 
 	constructor(args, opts) {
@@ -86,6 +99,11 @@ module.exports = class extends Generator {
 				name: 'pluginAuthor',
 				message: 'Author:',
 			},
+			{
+				type: 'input',
+				name: 'pluginRepositoryUrl',
+				message: 'Repository URL:',
+			},
 			{
 				type: 'input',
 				name: 'pluginHomepageUrl',
@@ -98,10 +116,10 @@ module.exports = class extends Generator {
 			for (const prompt of prompts) {
 				props[prompt.name] = '';
 			}
-			this.props = props;
+			this.props = addDerivedProps(props);
 		} else {
 			return this.prompt(prompts).then(props => {
-				this.props = props;
+				this.props = addDerivedProps(props);
 			});
 		}
 	}
@@ -114,9 +132,10 @@ module.exports = class extends Generator {
 
 		const files = [
 			'.gitignore_TEMPLATE',
+			'.npmignore_TEMPLATE',
+			'GENERATOR_DOC.md',
 			'package_TEMPLATE.json',
 			'README.md',
-			'GENERATOR_DOC.md',
 			'tsconfig.json',
 			'webpack.config.js',
 		];

packages/generator-joplin/generators/app/templates/.gitignore_TEMPLATE

@@ -1,3 +1,3 @@
-dist/*
+dist/
 node_modules/
-*.jpl
+publish/

packages/generator-joplin/generators/app/templates/.npmignore_TEMPLATE

@@ -0,0 +1,8 @@
+*.md
+!README.md
+/*.jpl
+/api
+/src
+/dist
+tsconfig.json
+webpack.config.js

packages/generator-joplin/generators/app/templates/GENERATOR_DOC.md

@@ -37,6 +37,16 @@ To build the plugin, simply run `npm run dist`.
 
 The project is setup to use TypeScript, although you can change the configuration to use plain JavaScript.
 
+## Publishing the plugin
+
+To publish the plugin, add it to npmjs.com by running `npm publish`. Later on, a script will pick up your plugin and add it automatically to the Joplin plugin repository as long as the package satisfies these conditions:
+
+- In `package.json`, the name starts with "joplin-plugin-". For example, "joplin-plugin-toc".
+- In `package.json`, the keywords include "joplin-plugin".
+- In the `publish/` directory, there should be a .jpl and .json file (which are built by `npm run dist`)
+
+In general all this is done automatically by the plugin generator, which will set the name and keywords of package.json, and will put the right files in the "publish" directory. But if something doesn't work and your plugin doesn't appear in the repository, double-check the above conditions.
+
 ## Updating the plugin framework
 
 To update the plugin framework, run `yo joplin --update`

packages/generator-joplin/generators/app/templates/package_TEMPLATE.json

@@ -1,13 +1,17 @@
 {
-  "name": "joplin_plugin",
+  "name": "<%= packageName %>",
   "version": "1.0.0",
   "scripts": {
     "dist": "webpack",
-    "postinstall": "npm run dist"
+    "prepare": "npm run dist"
   },
   "license": "MIT",
+  "keywords": [
+    "joplin-plugin"
+  ],
   "devDependencies": {
     "@types/node": "^14.0.14",
+    "chalk": "^4.1.0",
     "copy-webpack-plugin": "^6.1.0",
     "fs-extra": "^9.0.1",
     "glob": "^7.1.6",

packages/generator-joplin/generators/app/templates/src/manifest.json

@@ -6,5 +6,6 @@
 	"name": "<%= pluginName %>",
 	"description": "<%= pluginDescription %>",
 	"author": "<%= pluginAuthor %>",
-	"homepage_url": "<%= pluginHomepageUrl %>"
+	"homepage_url": "<%= pluginHomepageUrl %>",
+	"repository_url": "<%= pluginRepositoryUrl %>"
 }

packages/generator-joplin/generators/app/templates/webpack.config.js

@@ -1,9 +1,61 @@
 const path = require('path');
+const crypto = require('crypto');
 const fs = require('fs-extra');
+const chalk = require('chalk');
 const CopyPlugin = require('copy-webpack-plugin');
 const WebpackOnBuildPlugin = require('on-build-webpack');
 const tar = require('tar');
 const glob = require('glob');
+const execSync = require('child_process').execSync;
+
+const rootDir = path.resolve(__dirname);
+const distDir = path.resolve(rootDir, 'dist');
+const srcDir = path.resolve(rootDir, 'src');
+const publishDir = path.resolve(rootDir, 'publish');
+
+const manifestPath = `${srcDir}/manifest.json`;
+const packageJsonPath = `${rootDir}/package.json`;
+const manifest = readManifest(manifestPath);
+const pluginArchiveFilePath = path.resolve(publishDir, `${manifest.id}.jpl`);
+const pluginInfoFilePath = path.resolve(publishDir, `${manifest.id}.json`);
+
+fs.removeSync(distDir);
+fs.removeSync(publishDir);
+fs.mkdirpSync(publishDir);
+
+function validatePackageJson() {
+	const content = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+	if (!content.name || content.name.indexOf('joplin-plugin-') !== 0) {
+		console.warn(chalk.yellow(`WARNING: To publish the plugin, the package name should start with "joplin-plugin-" (found "${content.name}") in ${packageJsonPath}`));
+	}
+
+	if (!content.keywords || content.keywords.indexOf('joplin-plugin') < 0) {
+		console.warn(chalk.yellow(`WARNING: To publish the plugin, the package keywords should include "joplin-plugin" (found "${JSON.stringify(content.keywords)}") in ${packageJsonPath}`));
+	}
+
+	if (content.scripts && content.scripts.postinstall) {
+		console.warn(chalk.yellow(`WARNING: package.json contains a "postinstall" script. It is recommended to use a "prepare" script instead so that it is executed before publish. In ${packageJsonPath}`));
+	}
+}
+
+function fileSha256(filePath) {
+	const content = fs.readFileSync(filePath);
+	return crypto.createHash('sha256').update(content).digest('hex');
+}
+
+function currentGitInfo() {
+	try {
+		let branch = execSync('git rev-parse --abbrev-ref HEAD', { stdio: 'pipe' }).toString().trim();
+		const commit = execSync('git rev-parse HEAD', { stdio: 'pipe' }).toString().trim();
+		if (branch === 'HEAD') branch = 'master';
+		return `${branch}:${commit}`;
+	} catch (error) {
+		const messages = error.message ? error.message.split('\n') : [''];
+		console.info(chalk.cyan('Could not get git commit (not a git repo?):', messages[0].trim()));
+		console.info(chalk.cyan('Git information will not be stored in plugin info file'));
+		return '';
+	}
+}
 
 function readManifest(manifestPath) {
 	const content = fs.readFileSync(manifestPath, 'utf8');
@@ -19,7 +71,7 @@ function createPluginArchive(sourceDir, destPath) {
 	if (!distFiles.length) {
 		// Usually means there's an error, which is going to be printed by
 		// webpack
-		console.info('Plugin archive was not created because the "dist" directory is empty');
+		console.warn(chalk.yellow('Plugin archive was not created because the "dist" directory is empty'));
 		return;
 	}
 
@@ -36,21 +88,27 @@ function createPluginArchive(sourceDir, destPath) {
 		distFiles
 	);
 
-	console.info(`Plugin archive has been created in ${destPath}`);
+	console.info(chalk.cyan(`Plugin archive has been created in ${destPath}`));
 }
 
-const rootDir = path.resolve(__dirname);
-const distDir = path.resolve(rootDir, 'dist');
-const srcDir = path.resolve(rootDir, 'src');
-const manifestPath = `${srcDir}/manifest.json`;
-const manifest = readManifest(manifestPath);
-const archiveFilePath = path.resolve(__dirname, `${manifest.id}.jpl`);
+function createPluginInfo(manifestPath, destPath, jplFilePath) {
+	const contentText = fs.readFileSync(manifestPath, 'utf8');
+	const content = JSON.parse(contentText);
+	content._publish_hash = `sha256:${fileSha256(jplFilePath)}`;
+	content._publish_commit = currentGitInfo();
+	fs.writeFileSync(destPath, JSON.stringify(content, null, '\t'), 'utf8');
+}
 
-fs.removeSync(distDir);
+function onBuildCompleted() {
+	createPluginArchive(distDir, pluginArchiveFilePath);
+	createPluginInfo(manifestPath, pluginInfoFilePath, pluginArchiveFilePath);
+	validatePackageJson();
+}
 
 const baseConfig = {
 	mode: 'production',
 	target: 'node',
+	stats: 'errors-only',
 	module: {
 		rules: [
 			{
@@ -93,7 +151,7 @@ const lastStepConfig = {
 
 							// Currently we don't support JS files for the main
 							// plugin script. We support it for content scripts,
-							// but theyr should be declared in manifest.json,
+							// but they should be declared in manifest.json,
 							// and then they are also compiled and copied to
 							// /dist. So wse also don't need to copy JS files.
 							'**/*.js',
@@ -102,9 +160,7 @@ const lastStepConfig = {
 				},
 			],
 		}),
-		new WebpackOnBuildPlugin(function() {
-			createPluginArchive(distDir, archiveFilePath);
-		}),
+		new WebpackOnBuildPlugin(onBuildCompleted),
 	],
 };
 

packages/generator-joplin/package-lock.json

@@ -2463,6 +2463,11 @@
       "resolved": "https://registry.npmjs.org/slash/-/slash-1.0.0.tgz",
       "integrity": "sha1-xB8vbDn8FtHNF61LXYlhFK5HDVU="
     },
+    "slugify": {
+      "version": "1.4.6",
+      "resolved": "https://registry.npmjs.org/slugify/-/slugify-1.4.6.tgz",
+      "integrity": "sha512-ZdJIgv9gdrYwhXqxsH9pv7nXxjUEyQ6nqhngRxoAAOlmMGA28FDq5O4/5US4G2/Nod7d1ovNcgURQJ7kHq50KQ=="
+    },
     "snapdragon": {
       "version": "0.8.2",
       "resolved": "https://registry.npmjs.org/snapdragon/-/snapdragon-0.8.2.tgz",

packages/generator-joplin/package.json

@@ -20,10 +20,11 @@
   },
   "dependencies": {
     "chalk": "^2.1.0",
+    "slugify": "^1.4.6",
     "yeoman-generator": "^2.0.1",
     "yosay": "^2.0.1"
   },
   "repository": "https://github.com/laurent22/generator-joplin",
   "license": "MIT",
   "private": true
-}
+}