generator-sublimelinter 0.3.0 → 0.4.0

package/README.md

@@ -10,6 +10,7 @@
 
 **Features**
 
+- scaffolds Python code for your linter
 - adds any [SPDX](https://spdx.org/licenses/) license
 - adds CI/CD configuration
 - adds [EditorConfig](https://editorconfig.org/) configuration
@@ -27,7 +28,7 @@ $ npm install -g yo
  Use your preferred package manager to install this generator
 
 ```sh
-$ npm i generator-sublime -g
+$ npm i generator-sublimelinter -g
 ```
 
 ## Usage
@@ -35,7 +36,7 @@ $ npm i generator-sublime -g
 Run the generator and follow its instructions. Use `--help` for available flags.
 
 ```sh
-$ yo sublime
+$ yo sublimelinter
 ```
 
 *“That's all Folks!”*

package/generators/app/index.js

@@ -1,28 +1,32 @@
 import { mkdir } from 'node:fs/promises';
 import { resolve } from 'node:path';
+import { GeneratorCompat as Generator } from '@idleberg/yeoman-generator';
 import slugify from '@sindresorhus/slugify';
-import { pascalCase } from 'pascal-case';
+import { pascalCase } from 'change-case';
+import { inverse } from 'kleur/colors';
 import semver from 'semver';
 import spdxLicenseList from 'spdx-license-list/full.js';
 import terminalLink from 'terminal-link';
-import Generator from 'yeoman-generator';
-import { getDefaultSelector, licenseChoices, validateName } from '../lib/helpers.js';
+import { fileExists, getDefaultSelector, licenseChoices, validateName } from '../../lib/helpers.js';
 
 export default class extends Generator {
-	constructor(args, opts) {
-		super(args, opts);
+	constructor(args, options) {
+		super(args, options);
 
 		this.option('loose-version', { description: `Doesn't enforce semantic versioning`, default: false });
 		this.option('debug', { description: 'Prints debug messages', default: false });
 
 		this.looseVersion = this.options.looseVersion;
 		this.debug = this.options.debug;
+		this.outdir = this.options.debug ? '.debug' : '';
 
 		console.log(/* let it breathe */);
 	}
 
-	async inquirer() {
-		return this.prompt([
+	async prompting() {
+		this.clack.intro(inverse(` ${slugify(this.appname)} `));
+
+		const answers = await this.prompt([
 			{
 				name: 'name',
 				message: `What's name of the linter executable?`,
@@ -34,7 +38,7 @@ export default class extends Generator {
 			{
 				name: 'version',
 				message: `What's the plugin's initial version?`,
-				default: '0.0.0',
+				default: '0.1.0',
 				store: true,
 				validate: (version) =>
 					this.looseVersion === true || semver.valid(version) !== null
@@ -47,7 +51,7 @@ export default class extends Generator {
 			},
 			{
 				name: 'interface',
-				message: 'Specify the linter interface',
+				message: 'Specify a linter interface:',
 				type: 'list',
 				default: '(default)',
 				store: true,
@@ -84,7 +88,7 @@ export default class extends Generator {
 			},
 			{
 				name: 'selector',
-				message: `Specify the ${terminalLink(
+				message: `Specify a ${terminalLink(
 					'selector',
 					'http://www.sublimelinter.com/en/stable/linter_settings.html#selector',
 					{
@@ -92,14 +96,14 @@ export default class extends Generator {
 							return 'selector';
 						},
 					},
-				)}`,
+				)} for files that should be linted:`,
 				default: (answers) => getDefaultSelector(answers.interface),
 				store: true,
-				validate: (x) => (x.length > 0 ? true : 'You have to provide a valid selector'),
+				validate: (answer) => (answer?.length > 0 ? true : 'You have to provide a valid selector'),
 			},
 			{
 				name: 'errorStream',
-				message: `Specify the default ${terminalLink(
+				message: `Specify the output captured for the ${terminalLink(
 					'error stream',
 					'http://www.sublimelinter.com/en/stable/linter_attributes.html#error-stream',
 					{
@@ -107,7 +111,7 @@ export default class extends Generator {
 							return 'error stream';
 						},
 					},
-				)}`,
+				)}:`,
 				type: 'list',
 				default: 'STREAM_BOTH',
 				choices: [
@@ -128,7 +132,7 @@ export default class extends Generator {
 			},
 			{
 				name: 'multiline',
-				message: `RegEx pattern is ${terminalLink(
+				message: `Does the RegEx pattern capture ${terminalLink(
 					'multiline',
 					'http://www.sublimelinter.com/en/stable/linter_attributes.html#multiline',
 					{
@@ -136,7 +140,7 @@ export default class extends Generator {
 							return 'multiline';
 						},
 					},
-				)}`,
+				)}?`,
 				type: 'confirm',
 				default: false,
 				store: true,
@@ -145,11 +149,11 @@ export default class extends Generator {
 				name: 'author',
 				message: `What's your GitHub username?`,
 				store: true,
-				validate: (x) => (x.length > 0 ? true : 'You have to provide a username'),
+				validate: (answer) => (answer?.length > 0 ? true : 'You have to provide a username'),
 			},
 			{
 				name: 'spdxLicense',
-				message: 'Choose a license',
+				message: 'Choose a license for your linter:',
 				type: 'list',
 				default: 'MIT',
 				choices: licenseChoices,
@@ -158,7 +162,7 @@ export default class extends Generator {
 			{
 				type: 'checkbox',
 				name: 'tests',
-				message: 'Add tests',
+				message: 'Add CI/CD pipeline configurations?',
 				store: true,
 				choices: [
 					{
@@ -183,94 +187,101 @@ export default class extends Generator {
 			},
 			{
 				name: 'flakeArgs',
-				message: `Specify ${terminalLink('flake8', 'http://flake8.pycqa.org/', {
+				message: `Specify arguments for ${terminalLink('flake8', 'http://flake8.pycqa.org/', {
 					fallback() {
 						return 'flake8';
 					},
-				})} arguments`,
-				default: '-ignore=D211',
+				})}:`,
+				default: '--extend-ignore=D211',
 				store: true,
 				when: (answers) => answers.tests.length > 0,
 			},
 			{
 				name: 'pepArgs',
-				message: `Specify ${terminalLink('pep257', 'https://pep257.readthedocs.io/', {
+				message: `Specify arguments for ${terminalLink('pep257', 'https://pep257.readthedocs.io/', {
 					fallback() {
 						return 'pep257';
 					},
-				})} arguments`,
+				})}:`,
 				default: '--ignore=D211',
 				store: true,
 				when: (answers) => answers.tests.length > 0,
 			},
 			{
 				name: 'initGit',
-				message: 'Initialize Git repository?',
+				message: 'Initialize a Git repository?',
 				type: 'confirm',
-				default: !this.fs.exists(resolve(process.cwd(), '.git', 'config')),
+				default: !(await fileExists(resolve(process.cwd(), '.git', 'config'))),
 			},
-		]).then(async (props) => {
-			if (this.options.debug) {
-				console.log(props);
-			}
-
-			props.slug = slugify(props.name);
-			props.repositoryName = `SublimeLinter-contrib-${props.slug}`;
-			props.className = pascalCase(props.name);
-			props.multiline = props.multiline === true ? 'True' : 'False';
+		]);
 
-			if (typeof props.spdxLicense !== 'undefined') {
-				props.licenseName = spdxLicenseList[props.spdxLicense].name;
-				props.licenseText = spdxLicenseList[props.spdxLicense].licenseText.replace(/\n{3,}/g, '\n\n');
-			}
+		this.answers = answers;
+	}
 
-			if (typeof props.spdxLicense !== 'undefined') {
-				this.fs.copyTpl(this.templatePath('LICENSE.ejs'), this.destinationPath('LICENSE'), {
-					licenseText: props.licenseText,
-				});
-			}
+	async writing() {
+		if (this.options.debug) {
+			console.log(this.answers);
+		}
 
-			if (props.tests.includes('circleCI')) {
-				await mkdir('.circleci', {
-					recursive: true,
-				});
+		this.answers.slug = slugify(this.answers.name);
+		this.answers.repositoryName = `SublimeLinter-contrib-${this.answers.slug}`;
+		this.answers.className = pascalCase(this.answers.name);
+		this.answers.multiline = this.answers.multiline === true ? 'True' : 'False';
 
-				this.fs.copyTpl(this.templatePath('config-circleci.ejs'), this.destinationPath('.circleci/config.yml'), {
-					flakeArgs: props.flakeArgs.trim(),
-					pepArgs: props.pepArgs.trim(),
-				});
-			}
+		if (typeof this.answers.spdxLicense !== 'undefined') {
+			this.answers.licenseName = spdxLicenseList[this.answers.spdxLicense].name;
+			this.answers.licenseText = spdxLicenseList[this.answers.spdxLicense].licenseText.replace(/\n{3,}/g, '\n\n');
+		}
 
-			if (props.tests.includes('githubWorkflow')) {
-				await mkdir('.github/workflows', {
-					recursive: true,
-				});
+		if (typeof this.answers.spdxLicense !== 'undefined') {
+			this.fs.copyTpl(this.templatePath('LICENSE.eta'), this.destinationPath(this.outdir, 'LICENSE'), {
+				licenseText: this.answers.licenseText,
+			});
+		}
 
-				this.fs.copyTpl(this.templatePath('config-github.ejs'), this.destinationPath('.github/workflows/config.yml'), {
-					flakeArgs: props.flakeArgs.trim(),
-					pepArgs: props.pepArgs.trim(),
-				});
-			}
+		if (this.answers.tests.includes('circleCI')) {
+			await mkdir('.circleci', {
+				recursive: true,
+			});
 
-			this.fs.copy(this.templatePath('_editorconfig'), this.destinationPath('.editorconfig'));
+			this.fs.copyTpl(
+				this.templatePath('config-circleci.eta'),
+				this.destinationPath(this.outdir, '.circleci/config.yml'),
+				{
+					flakeArgs: this.answers.flakeArgs.trim(),
+					pepArgs: this.answers.pepArgs.trim(),
+				},
+			);
+		}
 
-			this.fs.copyTpl(this.templatePath('linter.py.ejs'), this.destinationPath('linter.py'), {
-				props: props,
+		if (this.answers.tests.includes('githubWorkflow')) {
+			await mkdir('.github/workflows', {
+				recursive: true,
 			});
 
-			this.fs.copyTpl(this.templatePath('README.md.ejs'), this.destinationPath('README.md'), {
-				props: props,
-			});
+			this.fs.copyTpl(
+				this.templatePath('config-github.eta'),
+				this.destinationPath(this.outdir, '.github/workflows/config.yml'),
+				{
+					flakeArgs: this.answers.flakeArgs.trim(),
+					pepArgs: this.answers.pepArgs.trim(),
+				},
+			);
+		}
+
+		this.fs.copy(this.templatePath('_editorconfig'), this.destinationPath(this.outdir, '.editorconfig'));
 
-			// Initialize git repository
-			if (props.initGit) {
-				this.spawnSync('git', ['init']);
-			}
+		this.fs.copyTpl(this.templatePath('linter.py.eta'), this.destinationPath(this.outdir, 'linter.py'), {
+			...this.answers,
+		});
 
-			// Open in Editor
-			if (props.openInEditor === true && typeof process.env.EDITOR === 'string') {
-				this.spawn(String(process.env.EDITOR), ['.']);
-			}
+		this.fs.copyTpl(this.templatePath('README.md.eta'), this.destinationPath(this.outdir, 'README.md'), {
+			...this.answers,
 		});
+
+		// Initialize git repository
+		if (this.answers.initGit) {
+			this.spawnSync('git', ['init']);
+		}
 	}
 }

package/generators/app/templates/LICENSE.eta

@@ -0,0 +1 @@
+<%= it.licenseText %>

package/generators/app/templates/README.md.eta

@@ -0,0 +1,35 @@
+# <%= it.repositoryName %>
+
+[![<%= it.licenseName %>](https://flat.badgen.net/badge/license/<%= it.spdxLicense %>/blue)](https://opensource.org/licenses/<%= it.spdxLicense %>)
+[![Version](https://badgen.net/github/release/<%= it.author %>/<%= it.repositoryName %>/stable)](https://github.com//<%= it.author %>/<%= it.repositoryName %>/releases/latest)<% if (it.tests.includes('circleCI')) { %>
+[![CircleCI](https://flat.badgen.net/circleci/github/<%= it.author %>/<%= it.repositoryName %>)](https://circleci.com/gh/<%= it.author %>/<%= it.repositoryName %>)<% } %>
+
+This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to `<%= it.slug %>`
+
+## Prerequisites
+
+1. Make sure you have [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) installed
+2. Ensure that `<%= it.slug %>` is installed on your system and available in your [PATH environmental variable](http://sublimelinter.readthedocs.io/en/latest/troubleshooting.html#finding-a-linter-executable)
+
+## Installation
+
+### Package Control
+
+1. Make sure you have [Package Control](https://packagecontrol.io/) installed
+2. Choose *“Install Package”* from the Command Palette (<kbd>Super</kbd>+<kbd>Shift</kbd>+<kbd>p</kbd>)
+3. Type *“<%= it.repositoryName %>”* and press <kbd>Enter</kbd>
+
+With the [`auto_upgrade`](https://packagecontrol.io/docs/settings#setting-auto_upgrade) setting enabled, Package Control will keep all installed packages up-to-date!
+
+### Using Git
+
+1. Change to your Sublime Text `Packages` directory
+2. Clone repository `git clone https://github.com/<%= it.author %>/<%= it.repositoryName %>.git <%= it.repositoryName %>`
+
+## Settings
+
+Please refer to the official documentation in order to tweak the [SublimeLinter settings](http://sublimelinter.readthedocs.org/en/latest/settings.html) or [linter settings](http://sublimelinter.readthedocs.org/en/latest/linter_settings.html).
+
+## License
+
+This work is licensed under the [<%= it.licenseName %>](LICENSE)

package/generators/app/templates/_editorconfig

@@ -2,18 +2,18 @@
 root = true
 
 [*]
-indent_style = space
-indent_size = 2
 charset = utf-8
-trim_trailing_whitespace = true
+end_of_line = lf
+indent_size = 2
+indent_style = tab
 insert_final_newline = true
-end_of_line = LF
+trim_trailing_whitespace = true
 
 [*.{py,rst,txt}]
+end_of_line = lf
+indent_size = 4
 indent_style = space
 trim_trailing_whitespace = true
-indent_size = 4
-end_of_line = LF
 
 [*.md]
 trim_trailing_whitespace = false

package/generators/app/templates/{config-circleci.ejs → config-circleci.eta}

@@ -28,8 +28,8 @@ jobs:
           name: Run tests
           command: |
             . venv/bin/activate
-            flake8 ./linter.py <%- flakeArgs %>
-            pep257 ./linter.py <%- pepArgs %>
+            flake8 ./linter.py <%= it.flakeArgs %>
+            pep257 ./linter.py <%= it.pepArgs %>
 
       - store_artifacts:
           path: test-reports

package/generators/app/templates/{config-github.ejs → config-github.eta}

@@ -49,8 +49,8 @@ jobs:
       - name: Run tests
         run: |
           . venv/bin/activate
-          flake8 ./linter.py <%- flakeArgs %>
-          pep257 ./linter.py <%- pepArgs %>
+          flake8 ./linter.py <%= it.flakeArgs %>
+          pep257 ./linter.py <%= it.pepArgs %>
 
       - name: Archive test reports
         uses: actions/upload-artifact@1746f4ab65b179e0ea60a494b83293b640dd5bba #v4.3.2

package/generators/app/templates/linter.py.eta

@@ -0,0 +1,27 @@
+#
+# linter.py
+# Copyright (c) <%= new Date().getFullYear() %> <%= it.author %>
+# <%= it.licenseName %>
+#
+# https://github.com/<%= it.author %>/<%= it.repositoryName %>
+#
+
+"""This module exports the <%= it.className %> plugin class."""
+
+from SublimeLinter.lint import <%= it.interface %>, util
+
+
+class <%= it.className %>(<%= it.interface %>):
+
+    """Provides an interface to the <%= it.className %> executable."""
+
+    cmd = ('<%= it.slug %>', '${file}')
+    defaults = {
+        'selector': '<%= it.selector %>'
+    }
+    regex = (
+        r'^(?P<file>.+):(?P<line>\d+):col (?P<col>\d+): (?P<message>.+)$'
+    )
+    multiline = <%= it.multiline %>
+    error_stream = util.<%= it.errorStream %>
+    line_col_base = (1, 1)

package/{generators/lib → lib}/helpers.js

@@ -1,4 +1,5 @@
 // @ts-check
+import { access, constants } from 'node:fs/promises';
 import spdxLicenseList from 'spdx-license-list/full.js';
 import terminalLink from 'terminal-link';
 
@@ -49,3 +50,18 @@ export function validateName(name) {
 
 	return true;
 }
+
+/**
+ *
+ * @param {string} filePath
+ * @returns {Promise<boolean>}
+ */
+export async function fileExists(filePath) {
+	try {
+		await access(filePath, constants.F_OK);
+	} catch {
+		return false;
+	}
+
+	return true;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-sublimelinter",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Yeoman generator for SublimeLinter plugins",
   "author": "Jan T. Sott",
   "license": "MIT",
@@ -11,47 +11,48 @@
     "sublime text"
   ],
   "type": "module",
-  "exports": "./generators/app",
+  "exports": "./generators/app/index.js",
   "files": [
     "generators",
+    "lib",
     "LICENSE",
     "README.md"
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/idleberg/generator-sublimelinter"
+    "url": "git+https://github.com/idleberg/generator-sublimelinter.git"
   },
   "engines": {
     "node": ">=20"
   },
   "dependencies": {
+    "@idleberg/yeoman-generator": "^0.1.1",
     "@sindresorhus/slugify": "^3.0.0",
-    "pascal-case": "^4.0.0",
+    "change-case": "^5.4.4",
     "semver": "^7.7.3",
-    "spdx-license-list": "^6.10.0",
+    "spdx-license-list": "^6.11.0",
     "terminal-link": "^5.0.0",
     "yeoman-generator": "^7.5.1"
   },
   "devDependencies": {
-    "@commitlint/cli": "^20.3.0",
-    "@commitlint/config-conventional": "^20.3.0",
+    "@commitlint/cli": "^20.3.1",
+    "@commitlint/config-conventional": "^20.3.1",
     "@idleberg/configs": "^0.4.1",
-    "@lukeed/uuid": "^2.0.1",
+    "@types/node": "^24.10.4",
     "@types/yeoman-assert": "^3.1.4",
-    "@yeoman/adapter": "^3.0.0",
+    "@yeoman/adapter": "^4.0.1",
     "@yeoman/types": "^1.8.0",
     "concurrently": "^9.2.1",
-    "ejs-lint": "^2.0.1",
-    "mem-fs": "^4.1.2",
+    "kleur": "^4.1.5",
+    "mem-fs": "^4.1.3",
     "np": "^10.2.0",
-    "vitest": "^4.0.16",
+    "vitest": "^4.0.17",
     "yeoman-assert": "^3.1.1",
     "yeoman-environment": "^5.1.1",
     "yeoman-test": "^11.2.0"
   },
   "scripts": {
-    "lint:e18e": "#e18e-cli analyze",
-    "lint:ejs": "ejslint generators/**/*.ejs",
+    "lint:e18e": "e18e-cli analyze",
     "lint:code": "biome check",
     "lint": "concurrently --prefix '{name}' -c 'green,blue' 'npm:lint:*'",
     "publish:npm": "np --no-yarn",

package/generators/app/templates/LICENSE.ejs

@@ -1 +0,0 @@
-<%- licenseText %>

package/generators/app/templates/README.md.ejs

@@ -1,34 +0,0 @@
-# <%= props.repositoryName %>
-
-[![<%= props.licenseName %>](https://flat.badgen.net/badge/license/<%= props.spdxLicense %>/blue)](https://opensource.org/licenses/<%= props.spdxLicense %>)<% if (props.tests.includes('circleCI')) { %>
-[![CircleCI](https://flat.badgen.net/circleci/github/<%= props.author %>/<%= props.repositoryName %>)](https://circleci.com/gh/<%= props.author %>/<%= props.repositoryName %>)<% } %>
-
-This linter plugin for [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) provides an interface to `<%= props.slug %>`
-
-## Prerequisites
-
-1. Make sure you have [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter) installed
-2. Ensure that `<%= props.slug %>` is installed on your system and available in your [PATH environmental variable](http://sublimelinter.readthedocs.io/en/latest/troubleshooting.html#finding-a-linter-executable)
-
-## Installation
-
-### Package Control
-
-1. Make sure you have [Package Control](https://packagecontrol.io/) installed
-2. Choose *“Install Package”* from the Command Palette (<kbd>Super</kbd>+<kbd>Shift</kbd>+<kbd>p</kbd>)
-3. Type *“<%= props.repositoryName %>”* and press <kbd>Enter</kbd>
-
-With the [`auto_upgrade`](https://packagecontrol.io/docs/settings#setting-auto_upgrade) setting enabled, Package Control will keep all installed packages up-to-date!
-
-### Using Git
-
-1. Change to your Sublime Text `Packages` directory
-2. Clone repository `git clone https://github.com/<%= props.author %>/<%= props.repositoryName %>.git <%= props.repositoryName %>`
-
-## Settings
-
-Please refer to the official documentation in order to tweak the [SublimeLinter settings](http://sublimelinter.readthedocs.org/en/latest/settings.html) or [linter settings](http://sublimelinter.readthedocs.org/en/latest/linter_settings.html).
-
-## License
-
-This work is licensed under the [<%= props.licenseName %>](LICENSE)

package/generators/app/templates/linter.py.ejs

@@ -1,27 +0,0 @@
-#
-# linter.py
-# Copyright (c) <%- new Date().getYear() %>> <%= props.author %>
-# <%= props.licenseName %>
-#
-# https://github.com/<%= props.author %>/<%= props.repositoryName %>
-#
-
-"""This module exports the <%= props.className %> plugin class."""
-
-from SublimeLinter.lint import <%= props.interface %>, util
-
-
-class <%= props.className %>(<%= props.interface %>):
-
-    """Provides an interface to the <%= props.className %> executable."""
-
-    cmd = ('<%= props.slug %>', '${file}')
-    defaults = {
-        'selector': '<%= props.selector %>'
-    }
-    regex = (
-        r'^(?P<file>.+):(?P<line>\d+):col (?P<col>\d+): (?P<message>.+)$'
-    )
-    multiline = <%= props.multiline %>
-    error_stream = util.<%= props.errorStream %>
-    line_col_base = (1, 1)