zharinov-nikita / create-snippet Goto Github PK

View Code? Open in Web Editor NEW

2.0 1.0 0.0 182 KB

npx tool for generating code snippets

Home Page: https://www.npmjs.com/package/create-snippet

Shell 0.28% JavaScript 2.64% TypeScript 97.08%

npx create-snippet code-generation code-snippet npm-pack snippet automating-code-creation create-code-snippet

create-snippet's Introduction

Installation

To install the create-snippet package, run the command:

npm i -D create-snippet

Basic commands

npx create-snippet --help or -h will show hints
npx create-snippet --init or -i initializes the project
npx create-snippet --generate or -g generates a new snippet
npx create-snippet --clear-cache or -cc clear cache

New snippet

When creating a new snippet, create a directory inside the directory .create-snippet with an arbitrary name, create the required number of files and directories inside this directory.

SnippetName

The strings snippetName specified inside the file or in the file name will be converted to a custom string when generating a new snippet.

PrefixName

The strings prefixName specified inside the file when generating a new snippet will be converted to custom strings.

SuffixName

The strings suffixName specified inside the file when generating a new snippet will be converted to custom strings.

Supported cases for strings

camelCase
PascalCase
lower_snake_case
UPPER_SNAKE_CASE
lower-kebab-case
UPPER-KEBAB-CASE

Specifying parameters via the console

snippet - any string
name - any string in the format lower-kebab-case
path - any string
prefix - any string in the format lower-kebab-case
suffix - any string in the format lower-kebab-case

create-snippet's People

Contributors

Stargazers

Watchers

create-snippet's Issues

Обновить utilStringFormatter

const util = new UtilStringFormatter()
util.toCamelCase(value: string)

Error [ENOENT]: ENOENT: no such file or directory, readdir 'src/scripts'

formatSnippet - refactoring

create-snippet/src/modules/snippet/snippet.module.ts

Lines 89 to 114 in 81b3103

    
           private formatSnippet(pathToSnippet: string) { 
        
             const unformattedSnippet = JSON.stringify(fs.readFileSync(nodePath.join(pathToSnippet), 'utf-8')) 
        
             const formattedSnippet = unformattedSnippet 
        
               .replaceAll(enumSnippetName.camelCase, `${this.moduleString.toCamelCase(this.options.name)}`) 
        
               .replaceAll(enumSnippetName.pascalCase, `${this.moduleString.toPascalCase(this.options.name)}`) 
        
               .replaceAll(enumSnippetName.lowerSnakeCase, `${this.moduleString.toLowerSnakeCase(this.options.name)}`) 
        
               .replaceAll(enumSnippetName.upperSnakeCase, `${this.moduleString.toUpperSnakeCase(this.options.name)}`) 
        
               .replaceAll(enumSnippetName.lowerKebabCase, `${this.moduleString.toLowerKebabCase(this.options.name)}`) 
        
               .replaceAll(enumSnippetName.upperKebabCase, `${this.moduleString.toUpperKebabCase(this.options.name)}`) 
        
               .replaceAll(enumPrefixName.camelCase, `${this.moduleString.toCamelCase(this.options.prefix)}`) 
        
               .replaceAll(enumPrefixName.pascalCase, `${this.moduleString.toPascalCase(this.options.prefix)}`) 
        
               .replaceAll(enumPrefixName.lowerSnakeCase, `${this.moduleString.toLowerSnakeCase(this.options.prefix)}`) 
        
               .replaceAll(enumPrefixName.upperSnakeCase, `${this.moduleString.toUpperSnakeCase(this.options.prefix)}`) 
        
               .replaceAll(enumPrefixName.lowerKebabCase, `${this.moduleString.toLowerKebabCase(this.options.prefix)}`) 
        
               .replaceAll(enumPrefixName.upperKebabCase, `${this.moduleString.toUpperKebabCase(this.options.prefix)}`) 
        
               .replaceAll(enumSuffixName.camelCase, `${this.moduleString.toCamelCase(this.options.suffix)}`) 
        
               .replaceAll(enumSuffixName.pascalCase, `${this.moduleString.toPascalCase(this.options.suffix)}`) 
        
               .replaceAll(enumSuffixName.lowerSnakeCase, `${this.moduleString.toLowerSnakeCase(this.options.suffix)}`) 
        
               .replaceAll(enumSuffixName.upperSnakeCase, `${this.moduleString.toUpperSnakeCase(this.options.suffix)}`) 
        
               .replaceAll(enumSuffixName.lowerKebabCase, `${this.moduleString.toLowerKebabCase(this.options.suffix)}`) 
        
               .replaceAll(enumSuffixName.upperKebabCase, `${this.moduleString.toUpperKebabCase(this.options.suffix)}`) 
        
             return JSON.parse(formattedSnippet) 
        
           }

1. Обновить версию в package.json при создании нового тега
2. При пуше в репозиторий тега сделать сборку и отправить в npm

Cannot find module 'C:\Users\Acer\AppData\Local\npm-cache\_npx\24961dc7c2bd16f8\node_modules\create-snippet\dist\index.js'

Добавить подсказки (any-string-in-kebab-case)

create-snippet/src/modules/snippet/snippet.module.ts

Lines 42 to 78 in fd6b180

    
           private async addOptions() { 
        
             const data = async () => [ 
        
               { 
        
                 type: 'select', 
        
                 name: 'snippetName', 
        
                 message: 'Pick a snippet', 
        
                 choices: fs.readdirSync(this.rootDirConfig).map((path) => { 
        
                   return { title: path, value: path } 
        
                 }), 
        
                 initial: 0, 
        
               }, 
        
               { type: 'text', name: 'name', message: 'Pick a name' }, 
        
               { type: 'text', name: 'path', message: 'Pick a path' }, 
        
               { 
        
                 type: 'toggle', 
        
                 name: 'isFlat', 
        
                 message: 'Create a flat file structure?', 
        
                 initial: false, 
        
                 active: 'yes', 
        
                 inactive: 'no', 
        
               }, 
        
               { 
        
                 type: async (_: any, values: TypeOptionsSnippetGeneration) => { 
        
                   return (await this.check(values.snippetName)).isPrefix ? 'text' : null 
        
                 }, 
        
                 name: 'prefix', 
        
                 message: 'Pick a prefix', 
        
               }, 
        
               { 
        
                 type: async (_: any, values: TypeOptionsSnippetGeneration) => { 
        
                   return (await this.check(values.snippetName)).isSuffix ? 'text' : null 
        
                 }, 
        
                 name: 'suffix', 
        
                 message: 'Pick a suffix', 
        
               }, 
        
             ]

vs-code extension

Создавать простые (только один файл) и сложные (из нескольких файлов)

Простой сниппет - состоит из одного файла
Сложный снипет - состоит из нескольких файлов

Чтобы создать все файлы за один проход, достаточно указать путь к папке ui
Чтобы создать определенный файл, достаточно указать путь к определенному файлу или массив файлов ["ui/template-name.hook.ts", "index.ts"]

📁ui
├──📁template-name.component.ts
├──📁temlate-name.hook.ts
└──📁index.ts

init
create

Refactoring (ModuleSnippet)

create-snippet/src/modules/snippet/snippet.module.ts

Lines 124 to 135 in 81b3103

    
           if (new RegExp(enumPrefixName.camelCase).test(data)) prefix += 1 
        
           if (new RegExp(enumPrefixName.lowerKebabCase).test(data)) prefix += 1 
        
           if (new RegExp(enumPrefixName.lowerSnakeCase).test(data)) prefix += 1 
        
           if (new RegExp(enumPrefixName.pascalCase).test(data)) prefix += 1 
        
           if (new RegExp(enumPrefixName.upperKebabCase).test(data)) prefix += 1 
        
           if (new RegExp(enumPrefixName.upperSnakeCase).test(data)) prefix += 1 
        
           if (new RegExp(enumSuffixName.camelCase).test(data)) suffix += 1 
        
           if (new RegExp(enumSuffixName.lowerKebabCase).test(data)) suffix += 1 
        
           if (new RegExp(enumSuffixName.lowerSnakeCase).test(data)) suffix += 1 
        
           if (new RegExp(enumSuffixName.pascalCase).test(data)) suffix += 1 
        
           if (new RegExp(enumSuffixName.upperKebabCase).test(data)) suffix += 1 
        
           if (new RegExp(enumSuffixName.upperSnakeCase).test(data)) suffix += 1

	private formatSnippet(pathToSnippet: string) {
	const unformattedSnippet = JSON.stringify(fs.readFileSync(nodePath.join(pathToSnippet), 'utf-8'))
	const formattedSnippet = unformattedSnippet
	.replaceAll(enumSnippetName.camelCase, `${this.moduleString.toCamelCase(this.options.name)}`)
	.replaceAll(enumSnippetName.pascalCase, `${this.moduleString.toPascalCase(this.options.name)}`)
	.replaceAll(enumSnippetName.lowerSnakeCase, `${this.moduleString.toLowerSnakeCase(this.options.name)}`)
	.replaceAll(enumSnippetName.upperSnakeCase, `${this.moduleString.toUpperSnakeCase(this.options.name)}`)
	.replaceAll(enumSnippetName.lowerKebabCase, `${this.moduleString.toLowerKebabCase(this.options.name)}`)
	.replaceAll(enumSnippetName.upperKebabCase, `${this.moduleString.toUpperKebabCase(this.options.name)}`)

	.replaceAll(enumPrefixName.camelCase, `${this.moduleString.toCamelCase(this.options.prefix)}`)
	.replaceAll(enumPrefixName.pascalCase, `${this.moduleString.toPascalCase(this.options.prefix)}`)
	.replaceAll(enumPrefixName.lowerSnakeCase, `${this.moduleString.toLowerSnakeCase(this.options.prefix)}`)
	.replaceAll(enumPrefixName.upperSnakeCase, `${this.moduleString.toUpperSnakeCase(this.options.prefix)}`)
	.replaceAll(enumPrefixName.lowerKebabCase, `${this.moduleString.toLowerKebabCase(this.options.prefix)}`)
	.replaceAll(enumPrefixName.upperKebabCase, `${this.moduleString.toUpperKebabCase(this.options.prefix)}`)

	.replaceAll(enumSuffixName.camelCase, `${this.moduleString.toCamelCase(this.options.suffix)}`)
	.replaceAll(enumSuffixName.pascalCase, `${this.moduleString.toPascalCase(this.options.suffix)}`)
	.replaceAll(enumSuffixName.lowerSnakeCase, `${this.moduleString.toLowerSnakeCase(this.options.suffix)}`)
	.replaceAll(enumSuffixName.upperSnakeCase, `${this.moduleString.toUpperSnakeCase(this.options.suffix)}`)
	.replaceAll(enumSuffixName.lowerKebabCase, `${this.moduleString.toLowerKebabCase(this.options.suffix)}`)
	.replaceAll(enumSuffixName.upperKebabCase, `${this.moduleString.toUpperKebabCase(this.options.suffix)}`)

	return JSON.parse(formattedSnippet)
	}

	private async addOptions() {
	const data = async () => [
	{
	type: 'select',
	name: 'snippetName',
	message: 'Pick a snippet',
	choices: fs.readdirSync(this.rootDirConfig).map((path) => {
	return { title: path, value: path }
	}),
	initial: 0,
	},
	{ type: 'text', name: 'name', message: 'Pick a name' },
	{ type: 'text', name: 'path', message: 'Pick a path' },
	{
	type: 'toggle',
	name: 'isFlat',
	message: 'Create a flat file structure?',
	initial: false,
	active: 'yes',
	inactive: 'no',
	},
	{
	type: async (_: any, values: TypeOptionsSnippetGeneration) => {
	return (await this.check(values.snippetName)).isPrefix ? 'text' : null
	},
	name: 'prefix',
	message: 'Pick a prefix',
	},

	{
	type: async (_: any, values: TypeOptionsSnippetGeneration) => {
	return (await this.check(values.snippetName)).isSuffix ? 'text' : null
	},
	name: 'suffix',
	message: 'Pick a suffix',
	},
	]

	if (new RegExp(enumPrefixName.camelCase).test(data)) prefix += 1
	if (new RegExp(enumPrefixName.lowerKebabCase).test(data)) prefix += 1
	if (new RegExp(enumPrefixName.lowerSnakeCase).test(data)) prefix += 1
	if (new RegExp(enumPrefixName.pascalCase).test(data)) prefix += 1
	if (new RegExp(enumPrefixName.upperKebabCase).test(data)) prefix += 1
	if (new RegExp(enumPrefixName.upperSnakeCase).test(data)) prefix += 1
	if (new RegExp(enumSuffixName.camelCase).test(data)) suffix += 1
	if (new RegExp(enumSuffixName.lowerKebabCase).test(data)) suffix += 1
	if (new RegExp(enumSuffixName.lowerSnakeCase).test(data)) suffix += 1
	if (new RegExp(enumSuffixName.pascalCase).test(data)) suffix += 1
	if (new RegExp(enumSuffixName.upperKebabCase).test(data)) suffix += 1
	if (new RegExp(enumSuffixName.upperSnakeCase).test(data)) suffix += 1

zharinov-nikita / create-snippet Goto Github PK

create-snippet's Introduction

Installation

Basic commands

New snippet

SnippetName

PrefixName

SuffixName

Supported cases for strings

Specifying parameters via the console

create-snippet's People

Contributors

Stargazers

Watchers

create-snippet's Issues

Recommend Projects

Recommend Topics

Recommend Org