imcuttle / edam Goto Github PK

View Code? Open in Web Editor NEW

10.0 3.0 2.0 3.7 MB

💥 The multifunctional scaffold generator.

Home Page: https://imcuttle.github.io/edam/index_zh

License: MIT License

JavaScript 51.48% TypeScript 44.78% Forth 0.11% HTML 0.41% EJS 2.73% Shell 0.49%

scaffold edam generator

edam's Introduction

Edam

💥 The multifunctional scaffold generator.

Processing

Why use edam?

	Edam	Plop
Inferred Configuration	✅	❌
Storing Prompt	✅	❌
Custom Loader(prettier)	✅	❌
CLI auto-completer	✅	❌
Unit Test Interface	✅	❌
PlugAble	✅	❌
Pulling from npm or git	✅	❌ (The template requires installed by npm, git has not supported)

Awesome 😎

Core

edam - The core package of edam.

Extensions

edam-cli - The official cli-app for edam.
edam-completer - Auto-complete source by configuration file for edam-cli.
edam-gh-completer - Auto-complete source by gh-repo for edam-cli.

Plugins

edam-plugin-dulcet-prompt - A dulcet prompt.

Loaders

edam-prettier-loader - A loader for more prettier via prettier.

edam's People

Contributors

Stargazers

Watchers

Forkers

teeeemoji inier

edam's Issues

Refactor: inquirer.createPromptModule() -> prompt function

should create isolate env for avoiding be effected by other
https://github.com/imcuttle/Inquirer.js#inquirercreatepromptmodule---prompt-function

Feat: supports declare computed value

Feat: support `scope` `ignore` globby files

edam --scope=*package.json  --ignore=*/index.js (-w)

Feat: the field `move` and `copy` of template config should more bash-like

// 1. support wild matching
move: {
  '*.{hbs, js}': ''
}
// 2. support array
move: [
  '*.{hbs, js}',
  'a.js b.js',
  '* a/'
]

Bug: cli pull npm client is not working

Feat: handlebar.js inject some bulit-in helper (e.g. `eq`)

https://stackoverflow.com/questions/34252817/handlebarsjs-check-if-a-string-is-equal-to-a-value

Feat: fake input in cli argument

https://plopjs.com/documentation/#bypassing-prompts

feature

global config
local config
multiply templates on same directory
command
variables rule (eg. #{BASENAME:lower} #{BASENAME:start} #{BASENAME:start,length} ) (CANCEL)

feat: fallback to cache when in offline

Perf(edam): use execa instead of the simple runner

Feat: add loader like plop (hbs) and to be preset

https://github.com/amwmedia/plop

{{ dashAround (properCase name) }}
{{> salutation greeting="Hello there" }}

{{#if toppings}}
on my pizza I like {{ wordJoin toppings }}
{{else}}
I don't like any toppings on my pizza (not human)
{{/if}}

generated by {{ pkg 'name' }}

Move field

move: {
  '**': 'a/',
  'x': 'x.js'
}

The above move field can't move 'x' to 'x.js'

move: {
  'x': 'x.js',
  '**': 'a/'
}

Feat: show diff view when has been existed, and make diff view pluggable

Perf(edam-cli): better the flow of run sequence like `np`.

Feat: support generate again

Feat(edam): support `pull.npmClientArgs`

{
    pull: {
       npmClientArgs: ['--registry=http://xxx']
    }
}

Perf: make `storePrompts` be more useful

https://github.com/SBoudrias/Inquirer.js/#reactive-interface

inquirer.prompt(prompts).ui.process.subscribe(onEachAnswer, onError, onComplete);

feat: use inquirer-autocomplete for edam-cli select template

component-vm

Doc: more information for help

Bug: appveyor ci should be passed

Bug: updateNotify is not working

Feat(edam-completer): more information about flags with highlight.

Like:

The doc link in repo description is wrong.

404

Feat: supports the description of each source in alias

// .edamrc
{
     alias: {
        abc: {
            type: 'npm',
            url: 'abc',
            description: 'wow!'
        }
     }
}

description was used in edam-completer
description was used in edam-cli when source is empty.