Typescript CLI skeleton and packages config

Author: darshkpatel

.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+  ],
+  rules: {
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        argsIgnorePattern: '^_',
+      },
+    ],
+  },
+};

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+build

.prettierignore

@@ -0,0 +1,9 @@
+# Package directories
+node_modules
+
+# Test coverage
+.nyc_output
+coverage
+
+# TypeScript build
+build

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "singleQuote": true
+}

README.md

@@ -0,0 +1 @@
+# Krinql CLI

package.json

@@ -0,0 +1,66 @@
+{
+  "name": "krinql-cli",
+  "version": "0.0.1",
+  "description": "A simple developer-friendly CLI for using Krinql",
+  "main": "./build/cli.js",
+  "bin": {
+    "krinql": "./build/cli.js",
+    "krinql-cli": "./build/cli.js"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "files": [
+    "/assets",
+    "/build"
+  ],
+  "keywords": [
+    "cli",
+    "krinql",
+    "codex",
+    "AI"
+  ],
+  "author": "Krinql <[email protected]> (krinql.com)",
+  "homepage": "https://krinql.com",
+  "bugs": "https://github.com/krinql/cli/issues",
+  "scripts": {
+    "build": "tsc",
+    "package:linux": "pkg . --no-bytecode --targets node14-linux-x64 --output bin/linux/snip",
+    "package:macos": "pkg . --no-bytecode --targets node14-macos-x64 --output bin/macos/snip",
+    "format": "prettier --loglevel warn --write \"**/*.{ts,js,json,yaml}\"",
+    "format:check": "prettier --loglevel warn --check \"**/*.{ts,js,json,yaml}\"",
+    "lint": "eslint \"src/**/*.ts\" --fix",
+    "lint:check": "eslint \"src/**/*.ts\""
+  },
+  "dependencies": {
+    "axios": "^0.24.0",
+    "chalk": "4.1.1",
+    "figlet": "^1.5.2",
+    "ora": "5.4.1",
+    "yargs": "17.0.1"
+  },
+  "devDependencies": {
+    "@types/figlet": "^1.5.4",
+    "@types/node": "16.0.1",
+    "@types/yargs": "17.0.2",
+    "@typescript-eslint/eslint-plugin": "4.28.2",
+    "@typescript-eslint/parser": "4.28.2",
+    "eslint": "7.30.0",
+    "eslint-config-prettier": "8.3.0",
+    "pkg": "5.3.0",
+    "prettier": "2.3.2",
+    "ts-node": "10.0.0",
+    "typescript": "4.3.5"
+  },
+  "pkg": {
+    "scripts": "build/**/*.js"
+  },
+  "ava": {
+    "extensions": [
+      "ts"
+    ],
+    "require": [
+      "ts-node/register"
+    ]
+  }
+}

src/cli.ts

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+
+import handleError from './handleError';
+
+yargs(hideBin(process.argv))
+  // Use the commands directory to scaffold.
+  .commandDir('commands')
+  // Default command if none supplied - shows help.
+  .command(
+    '$0',
+    'The Krinql CLI usage',
+    () => undefined,
+    () => {
+      yargs.showHelp();
+    },
+  )
+  // Enable strict mode.
+  .strict()
+  // Useful aliases.
+  .alias({ h: 'help' })
+  // Be nice.
+  .epilogue('For more information, checkout https://krinql.com')
+  // Handle failures.
+  .fail(handleError).argv;

src/commands/login.outputs.ts

@@ -0,0 +1,42 @@
+import chalk from 'chalk';
+import figlet from 'figlet';
+
+export const welcome = (): void => {
+  const welcomeAsciiText = figlet.textSync('Krinql')
+
+  process.stdout.write(`
+${welcomeAsciiText}
+
+Welcome to Krinql.
+Access krinql features without leaving your terminal or IDE.
+
+`);
+};
+
+export const userConfigFound = (profile: string): Promise<never> => {
+  process.stdout.write(`
+The profile ${chalk.cyan(profile)} is already configured! 👌
+
+If you would like to login using a new profile, run the following:
+
+    ${chalk.bold(
+      `$ krinql login --reauth`,
+    )}
+
+`);
+
+  process.exit(0);
+};
+
+export const deviceConfigured = async (configPath: string): Promise<never> => {
+  process.stdout.write(`
+✨ Configuration written to ${chalk.cyan(configPath)}.
+
+Let's try asking a question!
+
+    ${chalk.bold('$ krinql email regex javascript')}
+
+`);
+
+  process.exit(0);
+};

src/commands/login.ts

@@ -0,0 +1,50 @@
+import ora from 'ora';
+import * as outputs from './login.outputs';
+import { Builder, Handler } from './login.types';
+
+
+export const command = 'login';
+export const desc = 'Login with a new or existing account';
+
+export const builder: Builder = (yargs) =>
+  yargs
+    .options({
+      reauth: {
+        type: 'boolean',
+        desc: 're-authenticate using Krinql',
+        alias: 'reauth'
+      }
+    })
+    .example([
+      ['$0 login'],
+      ['$0 login --reauth'],
+    ]);
+
+export const handler: Handler = async (argv) => {
+  const spinner = ora()
+
+  const { reauth } = argv;
+
+  outputs.welcome();
+
+
+  spinner.start('Logging in');
+  // await api.login
+  spinner.succeed();
+
+
+
+
+    spinner.start('Fetching existing account configuration');
+
+
+    spinner.succeed();
+
+
+    // const configPath = await writeUserConfig({
+    // });
+
+    // outputs.deviceConfigured(configPath);
+
+
+};

src/commands/login.types.ts

@@ -0,0 +1,11 @@
+import type { Arguments, CommandBuilder } from 'yargs';
+
+import type { BaseOptions } from '../shared';
+
+export type Options = BaseOptions & {
+  reauth: boolean | undefined;
+};
+
+export type Builder = CommandBuilder<Options, Options>;
+
+export type Handler = (argv: Arguments<Options>) => PromiseLike<void>;

src/handleError.ts

@@ -0,0 +1,33 @@
+import chalk from 'chalk';
+import { EOL } from 'os';
+
+const printMessage = (message: string) => {
+  process.stderr.write(chalk.red(`Error: ${message}`) + EOL);
+  process.stderr.write(
+    `Hint: Use the ${chalk.green(
+      '--help',
+    )} option to get help about the usage` + EOL,
+  );
+};
+
+export default async (message: string, error: Error): Promise<never> => {
+  if (message) {
+    printMessage(message);
+    process.exit(1);
+  }
+
+  let errorMessage = 'Unknown error occurred';
+
+  if (error instanceof Response) {
+    const { ErrorMessage } = await error.json();
+
+    if (ErrorMessage) {
+      errorMessage = ErrorMessage;
+    }
+  } else {
+    errorMessage = error.message;
+  }
+
+  printMessage(errorMessage);
+  process.exit(1);
+};

src/services/api.ts

@@ -0,0 +1,7 @@
+
+import axios from 'axios';
+import { API_BASE_PATH } from '../shared';
+
+const api = axios.create({ baseURL: API_BASE_PATH });
+
+export default api;

src/services/config/index.ts

@@ -0,0 +1,7 @@
+export type UserConfig = {
+  Account: {
+    accessToken: string;
+    refreshToken: string;
+    name: string;
+  };
+};

src/shared.ts

@@ -0,0 +1,9 @@
+export type BaseOptions = {
+  query: string;
+};
+
+export const baseOptions = {
+  query: { type: 'string'},
+} as const;
+
+export const API_BASE_PATH = 'https://krinql.com/api';

tsconfig.json

@@ -0,0 +1,72 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                         /* Enable incremental compilation */
+    "target": "ES2020" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */,
+    // "lib": [],                                   /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                             /* Allow javascript files to be compiled. */
+    // "checkJs": true,                             /* Report errors in .js files. */
+    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
+    // "declaration": true,                         /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                      /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
+    // "outFile": "./",                             /* Concatenate and emit output to single file. */
+    "outDir": "./build" /* Redirect output structure to the directory. */,
+    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                           /* Enable project compilation */
+    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
+    // "removeComments": true,                      /* Do not emit comments to output. */
+    // "noEmit": true,                              /* Do not emit outputs. */
+    "importHelpers": false /* Import emit helpers from 'tslib'. */,
+    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,                     /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                       /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                    /* Enable strict null checks. */
+    // "strictFunctionTypes": true,                 /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,                 /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,        /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                      /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                        /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                      /* Report errors on unused locals. */
+    // "noUnusedParameters": true,                  /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,                   /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,          /* Report errors for fallthrough cases in switch statement. */
+    // "noUncheckedIndexedAccess": true,            /* Include 'undefined' in index signature results */
+    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",                  /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                             /* List of folders to include type definitions from. */
+    // "types": [],                                 /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "skipLibCheck": true /* Skip type checking of declaration files. */,
+    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
+  },
+  "exclude": ["test"]
+}