@necord/schematics 1.1.3 → 1.1.5

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@necord/schematics",
 	"description": "A collection of schematics for Necord projects with NestJS",
-	"version": "1.1.3",
+	"version": "1.1.5",
 	"scripts": {
 		"build": "rimraf -rf dist && tsc -p tsconfig.json",
 		"prepublish:npm": "npm run build",
@@ -13,12 +13,14 @@
 		"lint": "eslint --ignore-path .gitignore {integration,src}/**/*.ts",
 		"test": "jest"
 	},
-	"main": "./dist/index.js",
-	"types": "./dist/index.d.ts",
+	"schematics": "./src/collection.json",
+	"files": [
+		"src",
+		"*.md"
+	],
 	"publishConfig": {
 		"access": "public"
 	},
-	"schematics": "./src/collection.json",
 	"author": "Alexey Filippov <socket.someone@gmail.com>",
 	"license": "MIT",
 	"keywords": [

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/{dist/context-menu/context-menu-options.interface.d.ts → src/context-menu/context-menu-options.interface.ts}

@@ -1,5 +1,6 @@
 import { CommonOptions } from '../common';
 import { ContextMenuType } from './context-menu-type.enum';
+
 export interface ContextMenuOptions extends CommonOptions {
-    type: ContextMenuType;
+	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?"
+		}
+	}
+}

package/.prettierrc

@@ -1,8 +0,0 @@
-{
-	"parser": "typescript",
-	"trailingComma": "none",
-	"singleQuote": true,
-	"arrowParens": "avoid",
-	"endOfLine": "auto",
-	"printWidth": 120
-}

package/.release-it.json

@@ -1,8 +0,0 @@
-{
-	"git": {
-		"commitMessage": "chore: release v${version}"
-	},
-	"github": {
-		"release": true
-	}
-}

package/dist/common/common-options.interface.d.ts

@@ -1,11 +0,0 @@
-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/dist/common/common-options.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/common/index.d.ts

@@ -1,12 +0,0 @@
-import { Rule, Source } from '@angular-devkit/schematics';
-import { CommonOptions } from './common-options.interface';
-export * from './common-options.interface';
-export declare class CommonSchematicFactory<T extends CommonOptions = CommonOptions> {
-    templatePath: string;
-    type: string;
-    metadata: string;
-    create(options: T): Rule;
-    generate(options: T): Source;
-    addDeclarationToModule(options: T): Rule;
-    transform(source: T): T;
-}

package/dist/common/index.js

@@ -1,74 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommonSchematicFactory = void 0;
-const core_1 = require("@angular-devkit/core");
-const schematics_1 = require("@angular-devkit/schematics");
-const schematics_2 = require("@nestjs/schematics");
-const path_1 = require("path");
-__exportStar(require("./common-options.interface"), exports);
-class CommonSchematicFactory {
-    constructor() {
-        this.templatePath = './files';
-        this.type = 'service';
-        this.metadata = 'providers';
-    }
-    create(options) {
-        options = this.transform(options);
-        return (0, schematics_1.branchAndMerge)((0, schematics_1.chain)([(0, schematics_1.mergeWith)(this.generate(options)), this.addDeclarationToModule(options), (0, schematics_2.mergeSourceRoot)(options)]));
-    }
-    generate(options) {
-        return (context) => (0, schematics_1.apply)((0, schematics_1.url)((0, path_1.join)(this.templatePath)), [
-            options.spec ? (0, schematics_1.noop)() : (0, schematics_1.filter)((path) => !path.endsWith('.spec.ts')),
-            (0, schematics_1.applyTemplates)({
-                ...core_1.strings,
-                ...options,
-                lowercase: (str) => str.toLowerCase()
-            }),
-            (0, schematics_1.move)(options.path ?? '')
-        ])(context);
-    }
-    addDeclarationToModule(options) {
-        return (tree) => {
-            options.module = new schematics_2.ModuleFinder(tree).find({
-                name: options.name,
-                path: options.path
-            });
-            if (options.module === undefined || options.module === null) {
-                return tree;
-            }
-            const rawContent = tree.read(options.module);
-            const content = rawContent?.toString() ?? '';
-            const declarator = new schematics_2.ModuleDeclarator();
-            tree.overwrite(options.module, declarator.declare(content, options));
-            return tree;
-        };
-    }
-    transform(source) {
-        const target = Object.assign({}, source);
-        target.metadata = this.metadata;
-        target.type = this.type;
-        if (target.name === null || target.name === undefined) {
-            throw new schematics_1.SchematicsException('Option (name) is required.');
-        }
-        const location = new schematics_2.NameParser().parse(target);
-        target.name = core_1.strings.dasherize(location.name);
-        target.path = core_1.strings.dasherize(location.path);
-        target.path = target.flat ? target.path : (0, path_1.join)(target.path, target.name);
-        return target;
-    }
-}
-exports.CommonSchematicFactory = CommonSchematicFactory;

package/dist/context-menu/context-menu-options.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/context-menu/context-menu-type.enum.d.ts

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

package/dist/context-menu/context-menu-type.enum.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContextMenuType = void 0;
-var ContextMenuType;
-(function (ContextMenuType) {
-    ContextMenuType["Message"] = "message";
-    ContextMenuType["User"] = "user";
-})(ContextMenuType = exports.ContextMenuType || (exports.ContextMenuType = {}));

package/dist/context-menu/index.d.ts

@@ -1,3 +0,0 @@
-import { ContextMenuOptions } from './context-menu-options.interface';
-import { Rule } from '@angular-devkit/schematics';
-export declare function contextMenu(options: ContextMenuOptions): Rule;

package/dist/context-menu/index.js

@@ -1,27 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.contextMenu = void 0;
-const common_1 = require("../common");
-const context_menu_type_enum_1 = require("./context-menu-type.enum");
-class ContextMenuSchematicFactory extends common_1.CommonSchematicFactory {
-    constructor() {
-        super(...arguments);
-        this.type = 'context-menu';
-    }
-    generate(options) {
-        switch (options.type) {
-            case context_menu_type_enum_1.ContextMenuType.Message:
-                this.templatePath = './files/message-menu';
-                break;
-            case context_menu_type_enum_1.ContextMenuType.User:
-                this.templatePath = './files/user-menu';
-                break;
-        }
-        return super.generate(options);
-    }
-}
-function contextMenu(options) {
-    const contextMenuFactory = new ContextMenuSchematicFactory();
-    return contextMenuFactory.create(options);
-}
-exports.contextMenu = contextMenu;

package/jest.config.json

@@ -1,13 +0,0 @@
-{
-	"moduleFileExtensions": [
-		"js",
-		"json",
-		"ts"
-	],
-	"rootDir": "test",
-	"testRegex": ".*\\.spec\\.ts$",
-	"transform": {
-		"^.+\\.(t|j)s$": "ts-jest"
-	},
-	"testEnvironment": "node"
-}