# pasta-templates

> Terminal App for scaffolding and creating files based on templates

Latest version **0.1.0** (published 2016-02-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install pasta-templates
pnpm add pasta-templates
yarn add pasta-templates
bun add pasta-templates
```

Provides the command `pasta`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2016-02-02 |
| First published | 2016-01-12 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 5.0.0 |
| Dependencies | 7 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Alberto Forni |
| Maintainers | albertoforni |
| Keywords | react, cli, node |

## Links

- npm: https://www.npmjs.com/package/pasta-templates
- Repository: https://github.com/albertodotcom/pasta
- Homepage: https://github.com/albertodotcom/pasta#readme
- Issues: https://github.com/albertodotcom/pasta/issues
- npm.io page: https://npm.io/package/pasta-templates

## Dependencies (7)

- [when](https://npm.io/package/when.md) ^3.7.5
- [chalk](https://npm.io/package/chalk.md) ^1.1.1
- [plural](https://npm.io/package/plural.md) 0.2.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.5.3
- [winston](https://npm.io/package/winston.md) ^2.1.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.26.2
- [minimist](https://npm.io/package/minimist.md) ^1.2.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2016-02-02
- 0.0.2 — 2016-01-12
- 0.0.1 — 2016-01-12

## README

# Pasta 🍝
[![Build Status](https://travis-ci.org/albertodotcom/pasta.svg)](https://travis-ci.org/albertodotcom/pasta)
[![Coverage Status](https://coveralls.io/repos/albertodotcom/pasta/badge.svg?branch=master&service=github)](https://coveralls.io/github/albertodotcom/pasta?branch=master)

Pasta allows developers to scaffold applications, or files based on their templates (souces) 🍅

## Status
The project is not ready yet. Some of the functionalities are still missing

- [ ] Use local configuartions files to drive
    - [ ] transformations
    - [X] `src` and `dest` file paths
    - [ ] initial script
- [ ] Imporve logging
- [ ] Imporve error handling and test coverage
- [ ] Imporve cli usage

## Crazy eary adopters
If you feel really brave and you want to use it, type
`npm install -g pasta-templates`

then type `pasta` to see the options:
```
usage: pasta [options] [command]

commands:

  new <name> <srcFolder or gitRepo> [destFolder] - create a scaffold project. Default destination folder path ./<name>
  create <template> <name> - create a set of files based on specific templates

  help - Display the available options

global options:

  -v, --verbose   show debug information
  -q, --quiet     only output critical errors
```

## Commands
### `pasta new`
This `pasta new` command creates a new project based on a folder or, more likely, an existing git repo.

For instance `pasta new memory https://github.com/albertodotcom/react-template.git` will:

1. create a new project in the `./memory` folder by cloning the specified github repo;
2. apply a trasformation to every file content using **memory** as **appName**. See the [transformation section](#trasform);
3. execute `npm install && git init && git add --all && git commit -m "Create scaffold project"`

### `pasta create`
The `pasta create` command uses templates to create a whole lot of things.
For now your current repo needs to have the following structure
```
...
templates
└── create
    └── component
        └── files...
```
By default the `src` and the `dest` folders are:
```
src => ./templates/create/templateType/
dest => ./src/templateTypes/
```
*note that dest folder is plural*

With this structure in place you can type `pasta create component Pesto` and `pasta` will:
1. copy all the files from `./templates/create/component/` folder to `./src/components/`
2. replace the files that have the `template` keyword with `Pesto`
3. transform the file content of every file using the process described at point 2 and 3 of the [transformation section](#trasform)

#### Customization
It is possible to add a custom `src` or `dest` folder by creating a `.pesto.json` in the `./template` folder.
`.pasta.json`
```json
{
  "create": {
    "component": {
      "from": "./test/assets/create/component/",
      "to": "./src/containers/{componentName}"
    }
  }
}
```

## Trasformations
both `new` and `create` commands are meant to perform file trasformations.
There are 2 types of transformations:
1. **change file name**, using the `template` keyword in the filename itself.
For example assuming you have a `templates` folder like the following one:
```
...
templates
└── create
    └── component
        └── template-test.js
        └── template.js
...
```
if you type `pasta create component Button`, you will get
```
...
src
└── components
    └── Button-test.js
    └── Button.js
templates
└── create
    └── component
        └── template-test.js
        └── template.js
...
```
2. **comment replacement**, using a comment in the line above the line you would like transform with this format
`||| nameInTheTemplate -> componentName`

For example if you have a react component in your `templates/create/component` folder like the following

```js
// ||| MyComponentName -> componentName
class MyComponentName extends React.Component {
  ...
}

// ||| MyComponentName -> componentName
export default MyComponentName;
```
when you run `pasta create component Button`, pasta will replace `MyComponentName` with `Button`
```js
class Button extends React.Component {
  ...
}

export default Button;
```

**I am still thinking about another type of transformation. Why?**
I would like to leave every template in a working state, so you can have linting on the file and test it.

---
_Source: https://npm.io/package/pasta-templates · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._