@necord/schematics 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Alexey Filippov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,31 @@
+# @necord/schematics
+
+This is a collection of schematics for Necord projects.
+
+### Testing
+
+To test locally, install `@angular-devkit/schematics-cli` globally and use the `schematics` command
+line tool. That tool acts the same as the `generate` command of the Angular CLI, but also has a
+debug mode.
+
+```bash
+npm i -g @angular-devkit/schematics-cli
+```
+
+Check the documentation with
+
+```bash
+schematics --help
+```
+
+Now you can execute generation commands.
+
+```bash
+schematics @necord/schematics:command
+```
+
+### Unit Testing
+
+`npm run test` will run the unit tests, using Jasmine as a runner and test framework.
+
+That's it!

package/package.json

@@ -0,0 +1,63 @@
+{
+	"name": "@necord/schematics",
+	"description": "A collection of schematics for Necord projects with NestJS",
+	"version": "1.1.0",
+	"scripts": {
+		"build": "rimraf -rf dist && tsc -p tsconfig.json",
+		"prepublish:npm": "npm run build",
+		"publish:npm": "release-it",
+		"prepublish:dev": "npm run build",
+		"publish:dev": "npm publish --access public --tag dev",
+		"prepare": "husky install .github/husky",
+		"format": "prettier --write \"src/**/*.ts\"",
+		"lint": "eslint --ignore-path .gitignore {integration,src}/**/*.ts",
+		"test": "jest"
+	},
+	"files": [
+		"src"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"schematics": "./src/collection.json",
+	"author": "Alexey Filippov <socket.someone@gmail.com>",
+	"license": "MIT",
+	"keywords": [
+		"schematics",
+		"nest",
+		"nestjs-cli",
+		"nestjs",
+		"cli",
+		"inquirer",
+		"necord"
+	],
+	"dependencies": {
+		"@angular-devkit/core": "14.0.5",
+		"@angular-devkit/schematics": "14.0.5",
+		"rxjs": "7.8.0",
+		"@nestjs/schematics": "9.0.0"
+	},
+	"devDependencies": {
+		"@commitlint/cli": "17.5.0",
+		"@commitlint/config-angular": "17.4.4",
+		"@types/jest": "29.5.0",
+		"@types/node": "18.15.6",
+		"@typescript-eslint/eslint-plugin": "5.56.0",
+		"@typescript-eslint/parser": "5.56.0",
+		"eslint": "8.38.0",
+		"eslint-config-prettier": "8.8.0",
+		"eslint-plugin-import": "2.27.5",
+		"husky": "8.0.3",
+		"jest": "29.5.0",
+		"prettier": "2.8.7",
+		"release-it": "15.10.1",
+		"rimraf": "4.4.1",
+		"ts-jest": "29.0.5",
+		"typescript": "5.0.2"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/necordjs/schematics.git"
+	},
+	"homepage": "https://github.com/necordjs/schematics.git#readme"
+}

package/src/collection.json

@@ -0,0 +1,13 @@
+{
+	"$schema": "../node_modules/@angular-devkit/schematics/collection-schema.json",
+	"schematics": {
+		"context-menu": {
+			"description": "Generates a context menu component.",
+			"factory": "./context-menu/index#contextMenu",
+			"schema": "./context-menu/schema.json",
+			"aliases": [
+				"cm"
+			]
+		}
+	}
+}

package/src/command/schema.json

@@ -0,0 +1,30 @@
+{
+	"properties": {
+		"name": {
+			"type": "string",
+			"minLength": 1,
+			"x-prompt": "What is the questions set name?"
+		},
+		"path": {
+			"type": "string",
+			"format": "path",
+			"description": "The path to create the service."
+		},
+		"sourceRoot": {
+			"type": "string",
+			"description": "Nest service source root directory."
+		},
+		"flat": {
+			"type": "boolean",
+			"default": false,
+			"description": "Flag to indicate if a directory is created.",
+			"x-prompt": "Create a directory?"
+		},
+		"spec": {
+			"type": "boolean",
+			"default": true,
+			"description": "Specifies if a spec file is generated.",
+			"x-prompt": "Generate spec file as well?"
+		}
+	}
+}

package/src/common/common-options.interface.ts

@@ -0,0 +1,12 @@
+import { Path } from '@angular-devkit/core';
+
+export interface CommonOptions {
+	name: string;
+	spec: boolean;
+	flat: boolean;
+	sourceRoot: string;
+	path?: string | Path;
+	type?: string;
+	metadata?: string;
+	module?: Path | null;
+}

package/src/common/index.ts

@@ -0,0 +1,88 @@
+import { Path, strings } from '@angular-devkit/core';
+import {
+	apply,
+	applyTemplates,
+	branchAndMerge,
+	chain,
+	filter,
+	mergeWith,
+	move,
+	noop,
+	Rule,
+	SchematicContext,
+	SchematicsException,
+	Source,
+	Tree,
+	url
+} from '@angular-devkit/schematics';
+import {
+	DeclarationOptions,
+	Location,
+	mergeSourceRoot,
+	ModuleDeclarator,
+	ModuleFinder,
+	NameParser
+} from '@nestjs/schematics';
+import { join } from 'path';
+import { CommonOptions } from './common-options.interface';
+
+export * from './common-options.interface';
+
+export class CommonSchematicFactory<T extends CommonOptions = CommonOptions> {
+	public templatePath = './files';
+	public type = 'service';
+	public metadata = 'providers';
+
+	public create(options: T): Rule {
+		options = this.transform(options);
+		return branchAndMerge(
+			chain([mergeWith(this.generate(options)), this.addDeclarationToModule(options), mergeSourceRoot(options)])
+		);
+	}
+
+	public generate(options: T): Source {
+		return (context: SchematicContext) =>
+			apply(url(join(this.templatePath as Path)), [
+				options.spec ? noop() : filter((path: string) => !path.endsWith('.spec.ts')),
+				applyTemplates({
+					...strings,
+					...options,
+					lowercase: (str: string) => str.toLowerCase()
+				}),
+				move(options.path ?? '')
+			])(context);
+	}
+
+	public addDeclarationToModule(options: T): Rule {
+		return (tree: Tree) => {
+			options.module = new ModuleFinder(tree).find({
+				name: options.name,
+				path: options.path as Path
+			});
+			if (options.module === undefined || options.module === null) {
+				return tree;
+			}
+			const rawContent = tree.read(options.module);
+			const content = rawContent?.toString() ?? '';
+			const declarator: ModuleDeclarator = new ModuleDeclarator();
+			tree.overwrite(options.module, declarator.declare(content, options as DeclarationOptions));
+			return tree;
+		};
+	}
+
+	public transform(source: T): T {
+		const target: T = Object.assign({}, source);
+		target.metadata = this.metadata;
+		target.type = this.type;
+
+		if (target.name === null || target.name === undefined) {
+			throw new SchematicsException('Option (name) is required.');
+		}
+		const location: Location = new NameParser().parse(target);
+		target.name = strings.dasherize(location.name);
+		target.path = strings.dasherize(location.path);
+
+		target.path = target.flat ? target.path : join(target.path as Path, target.name);
+		return target;
+	}
+}

package/src/context-menu/context-menu-options.interface.ts

@@ -0,0 +1,6 @@
+import { CommonOptions } from '../common';
+import { ContextMenuType } from './context-menu-type.enum';
+
+export interface ContextMenuOptions extends CommonOptions {
+	type: ContextMenuType;
+}

package/src/context-menu/context-menu-type.enum.ts

@@ -0,0 +1,4 @@
+export enum ContextMenuType {
+	Message = 'message',
+	User = 'user'
+}

package/src/context-menu/files/user-menu/__name@dasherize__.commands.ts.template

@@ -0,0 +1,14 @@
+import { Injectable } from '@nestjs/common';
+import { Context, UserCommand, UserCommandContext, TargetUser } from 'necord';
+import { User } from 'discord.js';
+
+@Injectable()
+export class <%= classify(name) %>Commands {
+    @UserCommand({ name: <%= name.toLowerCase() %> })
+    public async <%= name %>(
+        @Context() [interaction]: UserCommandContext,
+        @TargetUser() user: User
+    ) {
+        return interaction.reply({ content: `Hello ${user.username}!` });
+    }
+}

package/src/context-menu/index.ts

@@ -0,0 +1,26 @@
+import { CommonSchematicFactory } from '../common';
+import { ContextMenuOptions } from './context-menu-options.interface';
+import { Rule, Source } from '@angular-devkit/schematics';
+import { ContextMenuType } from './context-menu-type.enum';
+
+class ContextMenuSchematicFactory extends CommonSchematicFactory<ContextMenuOptions> {
+	public type = 'context-menu';
+
+	generate(options: ContextMenuOptions): Source {
+		switch (options.type) {
+			case ContextMenuType.Message:
+				this.templatePath = './files/message-menu';
+				break;
+			case ContextMenuType.User:
+				this.templatePath = './files/user-menu';
+				break;
+		}
+
+		return super.generate(options);
+	}
+}
+
+export function contextMenu(options: ContextMenuOptions): Rule {
+	const contextMenuFactory = new ContextMenuSchematicFactory();
+	return contextMenuFactory.create(options);
+}

package/src/context-menu/schema.json

@@ -0,0 +1,42 @@
+{
+	"properties": {
+		"name": {
+			"type": "string",
+			"minLength": 1,
+			"description": "Command name",
+			"x-prompt": "What is the command name?"
+		},
+		"path": {
+			"type": "string",
+			"format": "path",
+			"description": "The path to create the service."
+		},
+		"sourceRoot": {
+			"type": "string",
+			"description": "Nest service source root directory."
+		},
+		"flat": {
+			"type": "boolean",
+			"default": false,
+			"description": "Flag to indicate if a directory is created.",
+			"x-prompt": "Create a directory?"
+		},
+		"spec": {
+			"type": "boolean",
+			"default": true,
+			"description": "Specifies if a spec file is generated.",
+			"x-prompt": "Generate spec file as well?"
+		},
+		"type": {
+			"type": "string",
+			"description": "The type of context menu to create.",
+			"enum": [
+				"message",
+				"user"
+			]
+		}
+	},
+	"required": [
+		"type"
+	]
+}

package/src/message-component/schema.json

@@ -0,0 +1,30 @@
+{
+	"properties": {
+		"name": {
+			"type": "string",
+			"minLength": 1,
+			"x-prompt": "What is the questions set name?"
+		},
+		"path": {
+			"type": "string",
+			"format": "path",
+			"description": "The path to create the service."
+		},
+		"sourceRoot": {
+			"type": "string",
+			"description": "Nest service source root directory."
+		},
+		"flat": {
+			"type": "boolean",
+			"default": false,
+			"description": "Flag to indicate if a directory is created.",
+			"x-prompt": "Create a directory?"
+		},
+		"spec": {
+			"type": "boolean",
+			"default": true,
+			"description": "Specifies if a spec file is generated.",
+			"x-prompt": "Generate spec file as well?"
+		}
+	}
+}

package/src/modals/schema.json

@@ -0,0 +1,30 @@
+{
+	"properties": {
+		"name": {
+			"type": "string",
+			"minLength": 1,
+			"x-prompt": "What is the questions set name?"
+		},
+		"path": {
+			"type": "string",
+			"format": "path",
+			"description": "The path to create the service."
+		},
+		"sourceRoot": {
+			"type": "string",
+			"description": "Nest service source root directory."
+		},
+		"flat": {
+			"type": "boolean",
+			"default": false,
+			"description": "Flag to indicate if a directory is created.",
+			"x-prompt": "Create a directory?"
+		},
+		"spec": {
+			"type": "boolean",
+			"default": true,
+			"description": "Specifies if a spec file is generated.",
+			"x-prompt": "Generate spec file as well?"
+		}
+	}
+}