neoman
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.0-alpha001 • Public • Published

    npm version Build Status Windows Build status dependencies Status devDependencies Status codecov

    MIT License PRs Welcome Code of Conduct

    Neoman Template Manager

    neoman - Old Saxon. None, nobody.

    A template manager that intends to be nobody and nothing; it doesn't want to impose. Neoman knows that your code shouldn't have to become a project template, because it already is one. 😌

    Basic Usage

    Drop the following folder and file into your project, and Neoman will have all it needs.

    MyProject/.neoman.config/template.json

    A minimal template.json would look like this:

    {
        "name": "My Project Template",
        "description": "My useful project template will lead many to triumph.",
        "author": "Noh Body",
        "url": "https://en.wikipedia.org/wiki/Outis",
        "identity": "myprojtmp",
     
        "input": {
            "use": "prompt",
            "define": {
                "namespace": "What will the root namespace of your project be?"
            }
        },
     
        "transform": [
            { "subject": "my.project.namespace", "with": "{{namespace}}" }
        ],
     
        "#": "You don't need 'files' if you want the 'transform' and 'pathTransform' sections to apply to all files",
        "files": ["**/*.ts"]
    }

    Once your project is ready, setup a folder to store your templates, and copy the project folder there. Then, just point Neoman to it:

    neoman setdir ./my-templates-folder
    

    Now, you should be ready to start using it:

    mkdir new-folder
    cd new-folder
    neoman new myprojtmp
    

    Type neoman help for command help. If you run into any problems, please refer to the the wiki, first, and if worst comes to worse, file an issue.

    Happy templating!

    Documentation

    For documentation, please refer to the wiki.

    Building

    To build and run Neoman from source, clone the repository and, from the root of the cloned repository, run:

    npm install
    npm run build
    npm link
    neoman
    

    Help Wanted

    Internationalization (i18n)

    Fluent in another language? Please consider helping with translations.

    Plugins

    Familiar with parsers? Want to see Neoman transforms for your favorite programming language? Please review existing plugins and see if this might fit in with your hobby time.

    Keywords

    none

    Install

    npm i neoman

    DownloadsWeekly Downloads

    2

    Version

    1.0.0-alpha001

    License

    MIT

    Unpacked Size

    406 kB

    Total Files

    257

    Last publish

    Collaborators

    • cdibbs