zharinov-nikita / create-snippet Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.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%

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

create-snippet's People

Contributors

Stargazers

Watchers

create-snippet's Issues

run command

Выполнить массив команд переданных через консоль

Обновить utilStringFormatter

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

package.json file

findArg

Bin

https://github.com/zharinov-nikita/create-snippet/blob/master/src/bin/index.ts#L1-L11

Flat

Создание файлов без дополнительной директории

vs-code extension

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

loading

Статус загрузки в момент создания компонента

Testing (nodejs file system)

Запоминать последний путь указанный при создании сниппета

Error: create-snippet already initialized

Передавать переменные в файлы сниппета

SnippetVariable1
SnippetVariable2
SnippetVariable3

Добавить подсказки (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', 

 }, 

 ]

ENOENT: no such file or directory, scandir '.create-snippet'

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

eslint config

npx create-snippet --help (comander)

Добавить команду для документации

Получать пути к файлам для создания сниппетов без создания cli.json

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

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

prompts template (text=>select)

Разрешить добавлять новый файл сниппета (если его не существует)

Использовать путь к файлу .cli относительно package.json при выполнение скрипта через npx

PrefixName и SuffixName

Добавить возможность в файлах вместе с TemplateName использовать PreffixName

Вывод сообщения о созданых файлах в консоль

throw new Error('isSnippet');

`npx create-snippet init`

[is]-snippet-name

Если передать название снипепета как is-snippet-name, то будет предложен выбор (true/false) для его создания

Передавать через настройки путь к верхней директории

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

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

github-actions (npm published)

При пуше нового тега обновить версию в package.json и отправить пакет в npm

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

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

Создать документацию

scripts (разные исполняемые файлы bin в зависимости от переданных команд)

init
create

prompt (isPrefix, isSuffix)

isCase - определить какой case у строки (camelCase...)

Jest

Удалить .cli и cli.json из репозитория и добавить в .gitignore

Автокомплит при указании path через консоль

SOLID

JSON.stringify

Заменить метод JSON.stringify на точное копирование строки 🤔

Поддержка различных case для названий файлов сниппетов

Отображать вопросы (pick a suffix, pick a prefix) если они указаны в сниппете

docusaurus

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) 

 }

replaceAll

Поддержка различных case при передаче аргументов

readline nodejs

Преобразовать строку в любом формате (kebab, camel, pascal...) в один определенный

npx

argv => promts

Заменить argv на promts

	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

	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)
	}

zharinov-nikita / create-snippet Goto Github PK

create-snippet's People

Contributors

Stargazers

Watchers

create-snippet's Issues

Recommend Projects

Recommend Topics

Recommend Org