feat: init project

Author: iamyoki

.beginrc

@@ -0,0 +1,3 @@
+{
+  "tasks": [["🎉Example", "echo \"Hello world!\"", "An example task that prints hello world"]]
+}

.cache.javascript

@@ -0,0 +1,3 @@
+let name 
+[name] = [123]
+console.log(name)

.gitignore

@@ -0,0 +1,157 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

bin/begin-script.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+import chalk from 'chalk';
+import yargs from 'yargs';
+import {hideBin} from 'yargs/helpers';
+import {defaultCommand} from '../lib/commands/defaultCommand.js';
+import {getPkg} from '../lib/getPkg.js';
+
+const pkg = getPkg();
+
+const argv = yargs(hideBin(process.argv))
+  .usage(chalk.magenta('\n' + pkg.description))
+  .command('$0', 'Begin to run', {}, defaultCommand)
+  .example('npx $0', 'Begin to run')
+  .option('config', {alias: 'c', desc: 'Specified config filepath.\nDefaults to ".beginrc"', type: 'string'})
+  .alias('help', 'h')
+  .alias('version', 'v').argv;

lib/commands/defaultCommand.js

@@ -0,0 +1,46 @@
+import prompts from 'prompts';
+import {getConfig} from '../getConfig.js';
+import child_process from 'node:child_process';
+import {parseConfigTasks} from '../parseConfigTasks.js';
+import chalk from 'chalk';
+
+export async function defaultCommand(argv) {
+  const {config: specifiedConfigPath} = argv;
+
+  /** @type {import('../types.js').BeginConfig} */
+  const config = getConfig(specifiedConfigPath);
+
+  /** @type {{task: import('../types.js').TaskObjectForm}} */
+  const {task} = await prompts({
+    type: 'autocomplete',
+    name: 'task',
+    message: 'Select a task to run',
+    suggest: (input, choices) =>
+      Promise.resolve(
+        choices.filter(choice =>
+          choice.title.toLowerCase().includes(input.toLowerCase())
+        )
+      ),
+    clearFirst: true,
+    choices: parseConfigTasks(config).map(({name, script, description}) => ({
+      title: name ?? script,
+      value: {name, script, description},
+      description
+    }))
+  });
+
+  if (task) {
+    console.log();
+    console.log(
+      `${chalk.bgMagenta.bold(' Task ➤_ ')} ${chalk.magenta.bold(task.description)}
+      `
+    );
+    console.log(chalk.grey(task.script));
+    child_process.spawnSync(
+      task.script.split(' ')[0],
+      task.script.split(' ').slice(1),
+      {stdio: 'inherit', shell: true}
+    );
+    console.log();
+  }
+}

lib/getConfig.js

@@ -0,0 +1,37 @@
+import chalk from 'chalk';
+import {cosmiconfig, cosmiconfigSync} from 'cosmiconfig';
+
+/**Get begin config file */
+export function getConfig(specifiedConfigPath) {
+  const explorerSync = cosmiconfigSync('begin');
+
+  /** @type {import('cosmiconfig/dist/types').CosmiconfigResult} */
+  let result;
+
+  // specified config path or search
+  if (specifiedConfigPath) {
+    result = explorerSync.load(specifiedConfigPath);
+  } else {
+    result = explorerSync.search();
+  }
+
+  const isNotFound = !result || result.isEmpty;
+
+  // not found when specified
+  if (specifiedConfigPath && isNotFound) {
+    console.log(
+      chalk.red(`\nConfig file not found in ${specifiedConfigPath}\n`)
+    );
+    return
+  }
+
+  // not found when search
+  if (!specifiedConfigPath && isNotFound) {
+    console.log(
+      chalk.red('\nPlease add "begin.config.json" in the root directory\n')
+    );
+    return;
+  }
+
+  return result.config;
+}

lib/getPkg.js

@@ -0,0 +1,8 @@
+import {createRequire} from 'node:module';
+
+// Get internal source package.json
+export function getPkg() {
+  const require = createRequire(import.meta.url);
+  const pkg = require('../package.json');
+  return pkg;
+}

lib/parseConfigTasks.js

@@ -0,0 +1,27 @@
+import chalk from 'chalk';
+
+/**
+ * @param {import('./types').BeginConfig} config
+ * @returns {import('./types').TaskObjectForm[]}
+ */
+export function parseConfigTasks(config) {
+  return config.tasks.map(task => {
+    let name, script, description;
+
+    if (task.length < 2) {
+      throw console.log(chalk.red('Config validation error: task type wrong'));
+    }
+    if (task.length === 2) {
+      [script, description] = task;
+    }
+    if (task.length > 2) {
+      [name, script, description] = task;
+    }
+
+    return {
+      name,
+      script,
+      description
+    };
+  });
+}

lib/types.d.ts

@@ -0,0 +1,12 @@
+type TaskArrayForm1 = [script: string, description: string];
+type TaskArrayForm2 = [name: string, script: string, description: string];
+type TaskObjectForm = {
+  name?: string;
+  script: string;
+  description: string;
+};
+type Task = TaskArrayForm1 | TaskArrayForm2 | TaskObjectForm;
+
+export interface BeginConfig {
+  tasks: Task[];
+}

package.json

@@ -0,0 +1,23 @@
+{
+  "name": "begin-script",
+  "version": "0.0.0",
+  "type": "module",
+  "bin": {
+    "begin-script": "bin/begin-script.js"
+  },
+  "engines": {
+    "node": "^14.13.1 || >=16.0.0"
+  },
+  "files": [
+    "bin",
+    "lib"
+  ],
+  "license": "MIT",
+  "description": "➤_ A User-friendly CLI to run any npm scripts with one command from \"begin\"",
+  "dependencies": {
+    "chalk": "^5.0.1",
+    "cosmiconfig": "^7.0.1",
+    "prompts": "^2.4.2",
+    "yargs": "^17.5.1"
+  }
+}