README.md

@@ -1,57 +1,60 @@
-# @sapphirecode/snippeteer
-
-[![Package quality](https://packagequality.com/shield/@sapphirecode/snippeteer.svg)](https://packagequality.com/#?package=@sapphirecode/snippeteer)
-
-> macros for setting up projects or project parts
+# Snippeteer
 
 ## Installation
 
-> npm i -g @sapphirecode/snippeteer
+to work with the @scode scope you have to add the following line to your npmrc.
+for this particular one you'll have to add it to the global npmrc stored in your home folder (~/.npmrc)
 
-## Requirements
+```npmrc
+@scode:registry=https://npm.scode.ovh
+```
 
-installed on the system:
+then install the module using the following command
 
-- yarn
-- git
+```sh
+npm i -g @scode/snippeteer
+```
 
 ## Usage
 
-run `snippeteer` in console and choose a snippet, all necessary parameters will
-be asked interactively
+```sh
+snippeteer [snippet] [..args]
+```
 
-### Snippets
+All snippets will be executed relative to your current working directory!
 
-#### copyright
+## Snippets
 
-add copyright notice to .js, .ts and .mjs files, as well was generating a
-license file and adding fields like author and license to the package.json
+### Snippet
 
-#### jenkins
+Creates a new snippet template
 
-create a generic jenkinsfile
+```sh
+snippeteer snippet [name]
+```
 
-for node projects: automatically generates a jenkinsfile and jenkins.js for easy
-use in jenkins.
+### Node
 
-necessary scripts in the package.json:
+Creates a new nodejs project
 
-- ci: `yarn --frozen-lockfile && node jenkins.js`
-- compile: `tsc` or
-  `tsc --allowJs --declaration --emitDeclarationOnly index.js`, ...
+```sh
+snippeteer node [name]
+```
 
-compile should be the general compile task, for typescript: tsc, for commonjs:
-creating type definitions, ...
+### Jenkins
 
-#### node
+Adds files necessary for jenkins
 
-initializes a node project with the standard structure used by sapphirecode
-modules
+optionally with a js script for npm modules by adding 'node' as argument
 
-#### readme
+```sh
+snippeteer jenkins [node]
+```
 
-create a template readme file
+### Vue
 
-## License
+Adds files, dependencies and scripts for vue to a nodejs project
 
-BSD-3-Clause © Timo Hocker <timo@scode.ovh>
+```sh
+snippeteer vue
+```

lib/Snippet.ts

@@ -6,6 +6,5 @@
  */
 
 export interface Snippet {
-  is_active(): boolean;
   start(cwd: string): Promise<void>;
 }

lib/index.ts

@@ -12,22 +12,17 @@ import { Snippet } from './Snippet';
 
 (async (): Promise<void> => {
   const snippets = await fs.readdir (path.join (__dirname, 'snippets'));
-  const runners: Record<string, Snippet> = {};
-  await Promise.all (
-    snippets.map (async (s) => {
-      const runner = (new (
-        await import (`./snippets/${s}/index.js`)
-      ).default) as Snippet;
-      runners[s] = runner;
-    })
-  );
-  const snippet = await new AutoComplete ({
-    name:    'snippet',
-    message: 'choose a snippet',
-    choices: snippets.filter ((s) => runners[s].is_active ())
-  })
+  const snippet = await new AutoComplete (
+    {
+      name:    'snippet',
+      message: 'choose a snippet',
+      choices: snippets
+    }
+  )
     .run ();
-  runners[snippet].start (process.cwd ());
+  const runner
+  = new (await import (`./snippets/${snippet}/index.js`)).default as Snippet;
+  runner.start (process.cwd ());
 }) ()
   // eslint-disable-next-line no-console
   .catch ((e) => console.log (e));

lib/snippets/copyright/index.ts

@@ -19,10 +19,6 @@ import { FileMapper } from './file_mapper';
 import { CopyrightOptions } from './copyright_options';
 
 export default class Copyright implements Snippet {
-  public is_active (): boolean {
-    return true;
-  }
-
   private _options: CopyrightOptions | null = null;
   private _cwd = '';
   private _loaded_from_config = false;

lib/snippets/database/index.ts

@@ -8,11 +8,7 @@
 import { Snippet } from '../../Snippet';
 
 export default class Database implements Snippet {
-  public is_active (): boolean {
-    return false;
-  }
-
   public start (): Promise<void> {
-    return Promise.resolve ();
+    return new Promise ((res) => res ());
   }
 }

lib/snippets/jenkins/index.ts

@@ -12,10 +12,6 @@ import { apply_template, modify_json } from '../../Helper';
 import { general, node } from './Assets';
 
 export default class Jenkins implements Snippet {
-  public is_active (): boolean {
-    return true;
-  }
-
   public async start (): Promise<void> {
     const is_node = await new Confirm ({
       message: 'is the current project using nodejs?',

lib/snippets/node/index.ts

@@ -56,10 +56,6 @@ async function init_package (
 }
 
 export default class Node implements Snippet {
-  public is_active (): boolean {
-    return true;
-  }
-
   public async start (): Promise<void> {
     const folder = await new Input (
       { message: 'project name (leave empty for current folder):' }

lib/snippets/readme/index.ts

@@ -4,10 +4,6 @@ import { modify_json, apply_template } from '../../Helper';
 import { get_readme } from './Assets';
 
 export default class Readme implements Snippet {
-  public is_active (): boolean {
-    return true;
-  }
-
   public async start (): Promise<void> {
     const dev = await new Confirm ({
       message: 'is the package used as dev dependency?',