feat!: re-write to TypeScript

Co-authored-by: Evo <85353424+EvolutionX-10@users.noreply.github.com>
This commit is contained in:
Tofix.js
2022-09-13 06:35:02 +02:00
committed by GitHub
parent 9271da3076
commit bed31c1f49
22 changed files with 193 additions and 215 deletions

View File

@@ -1,2 +1,3 @@
.github/ .github/
CHANGELOG.md CHANGELOG.md
dist/

87
package-lock.json generated
View File

@@ -18,14 +18,15 @@
"undici": "^5.6.1" "undici": "^5.6.1"
}, },
"bin": { "bin": {
"sern": "src/index.js" "sern": "dist/index.js"
}, },
"devDependencies": { "devDependencies": {
"@favware/npm-deprecate": "1.0.5", "@favware/npm-deprecate": "1.0.5",
"@types/prompts": "2.0.14", "@types/prompts": "2.0.14",
"prettier": "2.7.1" "prettier": "2.7.1",
"typescript": "4.7.4"
}, },
"peerDependencies": { "engines": {
"node": ">= 16.10.x" "node": ">= 16.10.x"
} }
}, },
@@ -806,9 +807,9 @@
} }
}, },
"node_modules/lru-cache": { "node_modules/lru-cache": {
"version": "7.13.1", "version": "7.14.0",
"resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.13.1.tgz", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.14.0.tgz",
"integrity": "sha512-CHqbAq7NFlW3RSnoWXLJBxCWaZVBrfa9UEHId2M3AW8iEBurbqduNexEUCGc3SHc6iCYXNJCDi903LajSVAEPQ==", "integrity": "sha512-EIRtP1GrSJny0dqb50QXRUNBxHJhcpxHC++M5tD7RYbvLLn5KVWKsbyswSSqDuU15UFi3bgTQIY8nhDMeF6aDQ==",
"dev": true, "dev": true,
"engines": { "engines": {
"node": ">=12" "node": ">=12"
@@ -1009,28 +1010,6 @@
"node": ">= 0.6" "node": ">= 0.6"
} }
}, },
"node_modules/node": {
"version": "18.7.0",
"resolved": "https://registry.npmjs.org/node/-/node-18.7.0.tgz",
"integrity": "sha512-h5wBtW3jnRfJzAfKldQ3lp9V8EOmbS9EHg00nUlUWWVeMtX8NGyaYB3L+AnPAGNjgWSPPDHcsqJAwlysyGiZ0g==",
"hasInstallScript": true,
"peer": true,
"dependencies": {
"node-bin-setup": "^1.0.0"
},
"bin": {
"node": "bin/node"
},
"engines": {
"npm": ">=5.0.0"
}
},
"node_modules/node-bin-setup": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/node-bin-setup/-/node-bin-setup-1.1.0.tgz",
"integrity": "sha512-pTeU6NgUrexiLNtd+AKwvg6cngHMvj5FZ5e2bbv2ogBSIc9yhkXSSaTScfSRZnwHIh5YFmYSYlemLWkiKD7rog==",
"peer": true
},
"node_modules/node-fetch": { "node_modules/node-fetch": {
"version": "2.6.7", "version": "2.6.7",
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz",
@@ -1605,10 +1584,23 @@
"integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==",
"dev": true "dev": true
}, },
"node_modules/typescript": {
"version": "4.7.4",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz",
"integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==",
"dev": true,
"bin": {
"tsc": "bin/tsc",
"tsserver": "bin/tsserver"
},
"engines": {
"node": ">=4.2.0"
}
},
"node_modules/undici": { "node_modules/undici": {
"version": "5.8.0", "version": "5.10.0",
"resolved": "https://registry.npmjs.org/undici/-/undici-5.8.0.tgz", "resolved": "https://registry.npmjs.org/undici/-/undici-5.10.0.tgz",
"integrity": "sha512-1F7Vtcez5w/LwH2G2tGnFIihuWUlc58YidwLiCv+jR2Z50x0tNXpRRw7eOIJ+GvqCqIkg9SB7NWAJ/T9TLfv8Q==", "integrity": "sha512-c8HsD3IbwmjjbLvoZuRI26TZic+TSEe8FPMLLOkN1AfYRhdjnKBU6yL+IwcSCbdZiX4e5t0lfMDLDCqj4Sq70g==",
"engines": { "engines": {
"node": ">=12.18" "node": ">=12.18"
} }
@@ -2263,9 +2255,9 @@
} }
}, },
"lru-cache": { "lru-cache": {
"version": "7.13.1", "version": "7.14.0",
"resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.13.1.tgz", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.14.0.tgz",
"integrity": "sha512-CHqbAq7NFlW3RSnoWXLJBxCWaZVBrfa9UEHId2M3AW8iEBurbqduNexEUCGc3SHc6iCYXNJCDi903LajSVAEPQ==", "integrity": "sha512-EIRtP1GrSJny0dqb50QXRUNBxHJhcpxHC++M5tD7RYbvLLn5KVWKsbyswSSqDuU15UFi3bgTQIY8nhDMeF6aDQ==",
"dev": true "dev": true
}, },
"make-fetch-happen": { "make-fetch-happen": {
@@ -2416,21 +2408,6 @@
"integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==",
"dev": true "dev": true
}, },
"node": {
"version": "18.7.0",
"resolved": "https://registry.npmjs.org/node/-/node-18.7.0.tgz",
"integrity": "sha512-h5wBtW3jnRfJzAfKldQ3lp9V8EOmbS9EHg00nUlUWWVeMtX8NGyaYB3L+AnPAGNjgWSPPDHcsqJAwlysyGiZ0g==",
"peer": true,
"requires": {
"node-bin-setup": "^1.0.0"
}
},
"node-bin-setup": {
"version": "1.1.0",
"resolved": "https://registry.npmjs.org/node-bin-setup/-/node-bin-setup-1.1.0.tgz",
"integrity": "sha512-pTeU6NgUrexiLNtd+AKwvg6cngHMvj5FZ5e2bbv2ogBSIc9yhkXSSaTScfSRZnwHIh5YFmYSYlemLWkiKD7rog==",
"peer": true
},
"node-fetch": { "node-fetch": {
"version": "2.6.7", "version": "2.6.7",
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz",
@@ -2824,10 +2801,16 @@
"integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==",
"dev": true "dev": true
}, },
"typescript": {
"version": "4.7.4",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-4.7.4.tgz",
"integrity": "sha512-C0WQT0gezHuw6AdY1M2jxUO83Rjf0HP7Sk1DtXj6j1EwkQNZrHAg2XPWlq62oqEhYvONq5pkC2Y9oPljWToLmQ==",
"dev": true
},
"undici": { "undici": {
"version": "5.8.0", "version": "5.10.0",
"resolved": "https://registry.npmjs.org/undici/-/undici-5.8.0.tgz", "resolved": "https://registry.npmjs.org/undici/-/undici-5.10.0.tgz",
"integrity": "sha512-1F7Vtcez5w/LwH2G2tGnFIihuWUlc58YidwLiCv+jR2Z50x0tNXpRRw7eOIJ+GvqCqIkg9SB7NWAJ/T9TLfv8Q==" "integrity": "sha512-c8HsD3IbwmjjbLvoZuRI26TZic+TSEe8FPMLLOkN1AfYRhdjnKBU6yL+IwcSCbdZiX4e5t0lfMDLDCqj4Sq70g=="
}, },
"unique-filename": { "unique-filename": {
"version": "1.1.1", "version": "1.1.1",

View File

@@ -2,15 +2,17 @@
"name": "@sern/cli", "name": "@sern/cli",
"version": "0.4.2", "version": "0.4.2",
"description": "Official CLI for @sern/handler", "description": "Official CLI for @sern/handler",
"exports": "./src/index.js", "exports": "./dist/index.js",
"bin": { "bin": {
"sern": "./src/index.js" "sern": "./dist/index.js"
}, },
"type": "module", "type": "module",
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1", "test": "echo \"Error: no test specified\" && exit 1",
"format": "prettier --check .", "format": "prettier --check .",
"fix": "prettier --write ." "fix": "prettier --write .",
"build": "tsc",
"watch": "tsc --watch"
}, },
"repository": { "repository": {
"type": "git", "type": "git",
@@ -41,7 +43,8 @@
"devDependencies": { "devDependencies": {
"@favware/npm-deprecate": "1.0.5", "@favware/npm-deprecate": "1.0.5",
"@types/prompts": "2.0.14", "@types/prompts": "2.0.14",
"prettier": "2.7.1" "prettier": "2.7.1",
"typescript": "4.7.4"
}, },
"engines": { "engines": {
"node": ">= 16.10.x" "node": ">= 16.10.x"

View File

@@ -1,7 +1,6 @@
import prompts from 'prompts'; import prompt from 'prompts';
import { extraPrompt } from '../prompts/extra.js'; import { extraPrompt } from '../prompts/extra.js';
import { create } from '../utilities/create.js'; import { create } from '../utilities/create.js';
const { prompt } = prompts;
export async function extra() { export async function extra() {
const extra = await prompt([extraPrompt]); const extra = await prompt([extraPrompt]);

View File

@@ -1,19 +1,18 @@
import { cyanBright, green, yellowBright } from 'colorette'; import { cyanBright, green, magentaBright } from 'colorette';
export function help() { export function help() {
return ` return `
___ ___ _ __ _ __ ___ ___ _ __ _ __
/ __|/ _ \\ '__| '_ \\ / __|/ _ \\ '__| '_ \\
\\__ \\ __/ | | | | | \\__ \\ __/ | | | | |
|___/\\___|_| |_| |_| |___/\\___|_| |_| |_|
Welcome! Welcome!
If you're new to ${cyanBright('sern')}, run ${yellowBright( If you're new to ${cyanBright('sern')}, run ${magentaBright(
'sern init' 'sern init'
)} for an interactive setup to your new bot project! )} for an interactive setup to your new bot project!
${green( ${green(
`If you have any ideas, suggestions, bug reports, kindly join our support server: https://discord.gg/xzK5fUKT4r` `If you have any ideas, suggestions, bug reports, kindly join our support server: https://discord.gg/xzK5fUKT4r`
)} )}`;
`;
} }

View File

@@ -1,36 +1,32 @@
import prompts from 'prompts';
import ora from 'ora';
import { greenBright, redBright } from 'colorette'; import { greenBright, redBright } from 'colorette';
import { execa } from 'execa'; import { execa } from 'execa';
import { findUp } from 'find-up'; import { findUp } from 'find-up';
import ora from 'ora';
import prompt from 'prompts';
import { import {
cmds_dir, cmds_dir,
gitInit,
lang, lang,
main_dir, main_dir,
gitInit,
which_manager,
skip_install_dep,
name, name,
skip_install_dep,
which_manager,
} from '../prompts/init.js'; } from '../prompts/init.js';
import { npm } from '../utilities/npm.js';
import { cloneRepo, installDeps } from '../utilities/install.js';
import { editDirs, editMain } from '../utilities/edits.js';
import { writeFile } from 'fs/promises'; import { writeFile } from 'fs/promises';
const { prompt } = prompts; import { editDirs, editMain } from '../utilities/edits.js';
import { cloneRepo, installDeps } from '../utilities/install.js';
import { npm } from '../utilities/npm.js';
import type { PackageManagerChoice } from '../utilities/types.js';
/** export async function init(flags: Flags) {
* @param {{ y: string; sync: string; }} flags let data: PromptData;
*/ let git_init = true; // the default;
export async function init(flags) { let pm = flags.sync ? undefined : flags.y ? 'npm' : await npm();
let data;
let git_init;
let pm;
if (flags.y) { if (flags.y) {
const projectName = await prompt([name]); const projectName = await prompt([name]);
git_init = true; git_init = true;
pm = 'npm';
data = { data = {
name: projectName.name, name: projectName.name,
lang: 'typescript', lang: 'typescript',
@@ -38,12 +34,12 @@ export async function init(flags) {
cmds_dir: 'commands', cmds_dir: 'commands',
}; };
} else if (flags.sync) { } else if (flags.sync) {
data = await prompt([lang, main_dir, cmds_dir]); data = (await prompt([lang, main_dir, cmds_dir])) as PromptData;
} else { } else {
data = await prompt([name, lang, main_dir, cmds_dir]); data = (await prompt([name, lang, main_dir, cmds_dir])) as PromptData;
git_init = (await prompt([gitInit])).gitinit; git_init = (await prompt([gitInit])).gitinit;
pm = await npm();
} }
const language = data.lang === 'javascript-esm' ? 'javascript' : data.lang; const language = data.lang === 'javascript-esm' ? 'javascript' : data.lang;
const config = { const config = {
language, language,
@@ -68,9 +64,7 @@ export async function init(flags) {
if (!pkg) throw new Error('No package.json found!'); if (!pkg) throw new Error('No package.json found!');
if (pkg) { await writeFile(pkg.replace('package.json', 'sern.config.json'), file);
await writeFile(pkg.replace('package.json', 'sern.config.json'), file);
}
if (flags.sync) { if (flags.sync) {
console.log('Project was successfully synced!'); console.log('Project was successfully synced!');
@@ -79,14 +73,14 @@ export async function init(flags) {
git_init ? await git(data) : console.log(`Skipping git init...\n`); git_init ? await git(data) : console.log(`Skipping git init...\n`);
let choice; let choice: PackageManagerChoice;
if (pm === 'both') { if (pm === 'both') {
const chosen = await prompt([which_manager]); choice = (await prompt([which_manager])).manager;
choice = chosen.manager;
} else { } else {
const chosen = await prompt([skip_install_dep]); choice = (
choice = chosen.skip_install_dep ? pm : 'skip'; (await prompt([skip_install_dep])).skip_install_dep ? pm : 'skip'
) as PackageManagerChoice;
} }
await installDeps(choice, data.name); await installDeps(choice, data.name);
@@ -97,11 +91,8 @@ export async function init(flags) {
process.exit(0); process.exit(0);
} }
/** /** It initializes git */
* It initializes git async function git(data: Data) {
* @param data - The data object that contains the name of the project.
*/
async function git(data) {
const spin = ora({ const spin = ora({
text: 'Initializing git...', text: 'Initializing git...',
spinner: 'aesthetic', spinner: 'aesthetic',
@@ -122,13 +113,24 @@ async function git(data) {
spin.succeed('Git initialized!'); spin.succeed('Git initialized!');
} }
/** /** Wait for a specified number of milliseconds, then return a promise that resolves to undefined. */
* Wait for a specified number of milliseconds, then return a promise that resolves to undefined. async function wait(ms: number) {
* @param {number} ms - The number of milliseconds to wait.
* @returns A function that takes a single argument, ms, and returns a promise that resolves after ms
* milliseconds.
*/
async function wait(ms) {
const wait = (await import('util')).promisify(setTimeout); const wait = (await import('util')).promisify(setTimeout);
return wait(ms); return wait(ms);
} }
interface Data {
name: string;
}
interface Flags {
y: boolean;
sync: boolean;
}
interface PromptData {
name: string;
lang: 'typescript' | 'javascript' | 'javascript-esm';
main_dir: string;
cmds_dir: string;
}

View File

@@ -1,19 +1,15 @@
import { pluginsQ } from '../prompts/plugin.js'; import { pluginsQ } from '../prompts/plugin.js';
import prompts from 'prompts'; import prompt from 'prompts';
import { fetch } from 'undici'; import { fetch } from 'undici';
import fs from 'fs'; import fs from 'fs';
import { greenBright } from 'colorette'; import { greenBright } from 'colorette';
import { fromCwd } from '../utilities/fromCwd.js'; import { fromCwd } from '../utilities/fromCwd.js';
const { prompt } = prompts;
/** /**
* Installs plugins to project * Installs plugins to project
*/ */
export async function plugins() { export async function plugins() {
/** const e: string[] = (await prompt([await pluginsQ()])).list;
* @type {string[]}
*/
const e = (await prompt([await pluginsQ()])).list;
if (!e) process.exit(1); if (!e) process.exit(1);
for await (const url of e) { for await (const url of e) {
@@ -27,11 +23,7 @@ export async function plugins() {
); );
} }
/** async function download(url: string) {
* @param {string} url
* @returns File
*/
async function download(url) {
const data = await fetch(url, { method: 'GET' }) const data = await fetch(url, { method: 'GET' })
.then((res) => res.text()) .then((res) => res.text())
.catch(() => null); .catch(() => null);

View File

@@ -1,4 +1,6 @@
export const extraPrompt = { import type { PromptObject } from 'prompts';
export const extraPrompt: PromptObject = {
message: 'What extra feature do you want to add?', message: 'What extra feature do you want to add?',
name: 'extra', name: 'extra',
type: 'select', type: 'select',

View File

@@ -1,6 +1,7 @@
import { blueBright } from 'colorette'; import { blueBright } from 'colorette';
import type { PromptObject } from 'prompts';
export const lang = { export const lang: PromptObject = {
message: 'What language do you want the project to be in?', message: 'What language do you want the project to be in?',
name: 'lang', name: 'lang',
type: 'select', type: 'select',
@@ -23,40 +24,37 @@ export const lang = {
], ],
}; };
export const main_dir = { export const main_dir: PromptObject = {
message: 'What is the main directory of your project?', message: 'What is the main directory of your project?',
name: 'main_dir', name: 'main_dir',
type: 'text', type: 'text',
initial: 'src', initial: 'src',
}; };
export const cmds_dir = { export const cmds_dir: PromptObject = {
message: 'What is the directory of your commands?', message: 'What is the directory of your commands?',
name: 'cmds_dir', name: 'cmds_dir',
type: 'text', type: 'text',
initial: 'commands', initial: 'commands',
validate: (/** @type {string} */ dir) => validate: (dir: string) =>
dir === 'src' ? 'You can not use src as a directory' : true, dir === 'src' ? 'You can not use src as a directory' : true,
}; };
/** export const npmInit: PromptObject = {
* @type {import('prompts').PromptObject}
*/
export const npmInit = {
name: 'npm_init', name: 'npm_init',
type: 'confirm', type: 'confirm',
message: `Do you want ${blueBright('me')} to initialize npm?`, message: `Do you want ${blueBright('me')} to initialize npm?`,
initial: true, initial: true,
}; };
export const gitInit = { export const gitInit: PromptObject = {
name: 'gitinit', name: 'gitinit',
type: 'confirm', type: 'confirm',
message: `Do you want to ${blueBright('me')} to initialize git?`, message: `Do you want to ${blueBright('me')} to initialize git?`,
initial: true, initial: true,
}; };
export const which_manager = { export const which_manager: PromptObject = {
message: `Which manager do you want to use?`, message: `Which manager do you want to use?`,
name: 'manager', name: 'manager',
type: 'select', type: 'select',
@@ -80,21 +78,18 @@ export const which_manager = {
], ],
}; };
export const skip_install_dep = { export const skip_install_dep: PromptObject = {
name: 'skip_install_dep', name: 'skip_install_dep',
type: 'confirm', type: 'confirm',
message: `Do you want ${blueBright('me')} to install dependencies?`, message: `Do you want ${blueBright('me')} to install dependencies?`,
initial: false, initial: false,
}; };
/** export const name: PromptObject = {
* @type {import('prompts').PromptObject}
*/
export const name = {
message: 'What is your project name?', message: 'What is your project name?',
name: 'name', name: 'name',
type: 'text', type: 'text',
validate: (/**@type {string}*/ name) => validate: (name: string) =>
name.match('^(?:@[a-z0-9-*~][a-z0-9-*._~]*/)?[a-z0-9-~][a-z0-9-._~]*$') name.match('^(?:@[a-z0-9-*~][a-z0-9-*._~]*/)?[a-z0-9-~][a-z0-9-._~]*$')
? true ? true
: 'Invalid name', : 'Invalid name',

View File

@@ -1,7 +1,8 @@
import type { Choice, PromptObject } from 'prompts';
import { fetch } from 'undici'; import { fetch } from 'undici';
import { getLang } from '../utilities/getLang.js'; import { getLang } from '../utilities/getLang.js';
function upperCase(string) { function upperCase(string: string | null) {
if (string === null) { if (string === null) {
console.error('Lang property not found!'); console.error('Lang property not found!');
process.exit(0); process.exit(0);
@@ -9,24 +10,24 @@ function upperCase(string) {
return string === 'typescript' ? 'TypeScript' : 'JavaScript'; return string === 'typescript' ? 'TypeScript' : 'JavaScript';
} }
async function gimmechoices() { async function gimmechoices(): Promise<Choice[]> {
const lang = upperCase(await getLang().catch(() => null)); const lang = upperCase(await getLang().catch(() => null));
const link = `https://api.github.com/repos/sern-handler/awesome-plugins/contents/${lang}`; const link = `https://api.github.com/repos/sern-handler/awesome-plugins/contents/${lang}`;
const resp = await fetch(link).catch(() => null); const resp = await fetch(link).catch(() => null);
if (!resp) return { title: 'No plugins found!', value: '', disabled: true }; if (!resp)
return [{ title: 'No plugins found!', value: '', disabled: true }];
const data = await resp.json(); const data = (await resp.json()) as Data[];
return data.map( const choices = data.map((e) => ({
(/** @type {{ name: string; download_url: string; }} */ e) => ({ title: e.name,
title: e.name, value: e.download_url,
value: e.download_url, }));
}) return choices;
);
} }
export async function pluginsQ() { export async function pluginsQ(): Promise<PromptObject> {
return { return {
name: 'list', name: 'list',
type: 'autocompleteMultiselect', type: 'autocompleteMultiselect',
@@ -35,3 +36,8 @@ export async function pluginsQ() {
min: 1, min: 1,
}; };
} }
interface Data {
name: string;
download_url: string;
}

View File

@@ -1,7 +1,7 @@
import { URL, fileURLToPath } from 'url'; import { URL, fileURLToPath } from 'url';
import { resolve, dirname } from 'node:path'; import { resolve, dirname } from 'node:path';
import { readFile, mkdir, writeFile } from 'fs/promises'; import { readFile, mkdir, writeFile } from 'fs/promises';
const root = new URL('../', import.meta.url); const root = new URL('../../', import.meta.url);
const templates = new URL('./templates/', root); const templates = new URL('./templates/', root);
const extraURL = new URL('./extra/', templates); const extraURL = new URL('./extra/', templates);
@@ -9,13 +9,17 @@ const extraFolder = fileURLToPath(extraURL);
/** /**
* It creates a file with the name `name.lang.sern` in the `location` directory * It creates a file with the name `name.lang.sern` in the `location` directory
* @param {string} name - The name of the file. * @param name - The name of the file.
* @param {string} lang - The language you want to use. * @param lang - The language you want to use.
* @param {string} location - The location of the file to be created. * @param location - The location of the file to be created.
* @param {boolean} no_ext - If true, the file will be created without an extension. * @param no_ext - If true, the file will be created without an extension.
* @returns File
*/ */
export async function create(name, lang, location, no_ext) { export async function create(
name: string,
lang: string,
location: string,
no_ext: boolean
) {
const file = `${name}.${lang}.sern`; const file = `${name}.${lang}.sern`;
const target = no_ext const target = no_ext
@@ -27,10 +31,10 @@ export async function create(name, lang, location, no_ext) {
/** /**
* It reads a file from a template folder, and writes it to a target folder * It reads a file from a template folder, and writes it to a target folder
* @param {string} template - The name of the file to be created. * @param template - The name of the file to be created.
* @param {string} target - The location of the file to be created. * @param target - The location of the file to be created.
*/ */
async function createFile(template, target) { async function createFile(template: string, target: string) {
const location = `${extraFolder}${template}`; const location = `${extraFolder}${template}`;
const file = await readFile(location, 'utf8'); const file = await readFile(location, 'utf8');
@@ -40,11 +44,11 @@ async function createFile(template, target) {
/** /**
* It creates a directory recursively, then writes a file to it * It creates a directory recursively, then writes a file to it
* @param {string} target - The path to the file you want to write to. * @param target - The path to the file you want to write to.
* @param {string} data - The data to write to the file. * @param data - The data to write to the file.
* @returns A promise that resolves to the result of the writeFile function. * @returns A promise that resolves to the result of the writeFile function.
*/ */
async function writeFileRecursive(target, data) { async function writeFileRecursive(target: string, data: string) {
const resolvedTarget = resolve(target); const resolvedTarget = resolve(target);
const dir = dirname(resolvedTarget); const dir = dirname(resolvedTarget);

View File

@@ -5,13 +5,12 @@ import { fromCwd } from './fromCwd.js';
/** /**
* It takes a string, finds the package.json file in the directory of the string, and changes the name * It takes a string, finds the package.json file in the directory of the string, and changes the name
* of the package.json file to the string. * of the package.json file to the string.
* @param {string} name - The name of the project. * @param name - The name of the project.
* @returns A promise.
*/ */
export async function editMain(name) { export async function editMain(name: string) {
const pjLocation = await findUp('package.json', { const pjLocation = (await findUp('package.json', {
cwd: fromCwd('/' + name), cwd: fromCwd('/' + name),
}); })) as string;
const output = JSON.parse(await readFile(pjLocation, 'utf8')); const output = JSON.parse(await readFile(pjLocation, 'utf8'));
if (!output) throw new Error("Can't read your package.json."); if (!output) throw new Error("Can't read your package.json.");
@@ -24,36 +23,35 @@ export async function editMain(name) {
/** /**
* It renames the `src` and `commands` directories, and edits the `index.ts` file to reflect the * It renames the `src` and `commands` directories, and edits the `index.ts` file to reflect the
* changes * changes
* @param {string} srcName - The name of the folder that will contain your main files. * @param srcName - The name of the folder that will contain your main files.
* @param {string} cmds_dirName - The name of the directory where your commands will be stored. * @param cmds_dirName - The name of the directory where your commands will be stored.
* @param {string} name - The name of the folder you want to edit. * @param name - The name of the folder you want to edit.
* @param {'javascript' | 'typescript'} lang - The language you want to use. * @param lang - The language you want to use.
* @returns void
*/ */
export async function editDirs( export async function editDirs(
srcName, srcName: string,
cmds_dirName, cmds_dirName: string,
name, name: string,
lang = 'typescript' lang: 'javascript' | 'typescript' | 'javascript-esm' = 'typescript'
) { ) {
const path = await findUp('src', { const path = (await findUp('src', {
cwd: fromCwd(name), cwd: fromCwd(name),
type: 'directory', type: 'directory',
}); })) as string;
const ext = lang === 'typescript' ? 'ts' : 'js'; const ext = lang === 'typescript' ? 'ts' : 'js';
const newMainDir = path?.replace('src', srcName); const newMainDir = path?.replace('src', srcName);
await rename(path, newMainDir); await rename(path, newMainDir);
const cmdsPath = await findUp('commands', { const cmdsPath = (await findUp('commands', {
cwd: fromCwd(name, srcName), cwd: fromCwd(name, srcName),
type: 'directory', type: 'directory',
}); })) as string;
const index = await findUp(`index.${ext}`, { const index = (await findUp(`index.${ext}`, {
cwd: fromCwd(name, srcName), cwd: fromCwd(name, srcName),
}); })) as string;
const newCmdsPath = cmdsPath?.replace('commands', cmds_dirName); const newCmdsPath = cmdsPath?.replace('commands', cmds_dirName);
await rename(cmdsPath, newCmdsPath); await rename(cmdsPath, newCmdsPath);

View File

@@ -1,8 +1,5 @@
import path from 'path'; import path from 'path';
/** export function fromCwd(...dir: string[]) {
* @param {string[]} dir
*/
export function fromCwd(...dir) {
return path.join(...[process.cwd(), ...dir]); return path.join(...[process.cwd(), ...dir]);
} }

View File

@@ -3,9 +3,9 @@ import { readFile } from 'node:fs/promises';
/** /**
* It finds the sern.config.json file, reads it, and returns the language property * It finds the sern.config.json file, reads it, and returns the language property
* @returns {Promise<string>} The language of the project. * @returns The language of the project.
*/ */
export async function getLang() { export async function getLang(): Promise<'typescript' | 'javascript'> {
const sernLocation = await findUp('sern.config.json'); const sernLocation = await findUp('sern.config.json');
if (!sernLocation) throw new Error("Can't find sern.config.json"); if (!sernLocation) throw new Error("Can't find sern.config.json");

View File

@@ -1,18 +1,18 @@
import { execa } from 'execa';
import { redBright } from 'colorette'; import { redBright } from 'colorette';
import fs from 'fs'; import { execa } from 'execa';
import path from 'path';
import { readFile } from 'fs/promises';
import { findUp } from 'find-up'; import { findUp } from 'find-up';
import fs from 'fs';
import { readFile } from 'fs/promises';
import ora from 'ora'; import ora from 'ora';
import path from 'path';
import type { PackageManagerChoice } from './types';
/** /**
* It installs dependencies from a package.json file * It installs dependencies from a package.json file
* @param {'skip' | 'npm' | 'yarn'} choice - The package manager to use. * @param choice - The package manager to use.
* @param {string} name - The name of the project * @param name - The name of the project
* @returns a promise.
*/ */
export async function installDeps(choice, name) { export async function installDeps(choice: PackageManagerChoice, name: string) {
const pkg = await findUp('package.json', { const pkg = await findUp('package.json', {
cwd: process.cwd() + '/' + name, cwd: process.cwd() + '/' + name,
}); });
@@ -44,10 +44,10 @@ export async function installDeps(choice, name) {
/** /**
* Clone the repo, copy the files from the repo to the new project directory, and delete the repo * Clone the repo, copy the files from the repo to the new project directory, and delete the repo
* @param {string} lang - The language of the template * @param lang - The language of the template
* @param {string} name - The name of the project * @param name - The name of the project
*/ */
export async function cloneRepo(lang, name) { export async function cloneRepo(lang: string, name: string) {
await execa('git', [ await execa('git', [
'clone', 'clone',
`https://github.com/sern-handler/templates.git`, `https://github.com/sern-handler/templates.git`,
@@ -60,13 +60,13 @@ export async function cloneRepo(lang, name) {
* If the source is a directory, create the destination directory and then recursively copy the * If the source is a directory, create the destination directory and then recursively copy the
* contents of the source directory to the destination directory. If the source is not a directory, * contents of the source directory to the destination directory. If the source is not a directory,
* copy the source file to the destination file * copy the source file to the destination file
* @param {string} src - The source path. * @param src - The source path.
* @param {string} dest - The destination folder where the files will be copied to. * @param dest - The destination folder where the files will be copied to.
*/ */
export function copyRecursiveSync(src, dest) { export function copyRecursiveSync(src: string, dest: string) {
const exists = fs.existsSync(src); const exists = fs.existsSync(src);
const stats = exists && fs.statSync(src); const stats = (exists && fs.statSync(src)) as fs.Stats;
const isDirectory = exists && stats.isDirectory(); const isDirectory = exists && stats.isDirectory();
if (isDirectory) { if (isDirectory) {
@@ -82,8 +82,3 @@ export function copyRecursiveSync(src, dest) {
fs.copyFileSync(src, dest); fs.copyFileSync(src, dest);
} }
} }
// async function wait(ms) {
// const wait = (await import('util')).promisify(setTimeout);
// return wait(ms);
// }

1
src/utilities/types.ts Normal file
View File

@@ -0,0 +1 @@
export type PackageManagerChoice = 'skip' | 'npm' | 'yarn';

View File

@@ -1,17 +1,18 @@
{ {
"compilerOptions": { "compilerOptions": {
"target": "ES2022", "target": "ESNext",
"module": "ESNext", "module": "ESNext",
"moduleResolution": "NodeNext", "moduleResolution": "Node",
"lib": ["es2017", "dom"], "outDir": "dist",
"allowJs": true, "rootDir": "src",
"checkJs": true, "declaration": true,
"noEmit": true, "declarationMap": true,
"strict": false, "strict": true,
"noImplicitThis": true,
"alwaysStrict": true,
"esModuleInterop": true, "esModuleInterop": true,
"resolveJsonModule": true "noImplicitAny": true,
}, "strictNullChecks": true,
"include": ["test", "src"] "importsNotUsedAsValues": "error",
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true
}
} }