# create-sywac

> npm init sywac

Latest version **0.2.1** (published 2020-05-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install create-sywac
pnpm add create-sywac
yarn add create-sywac
bun add create-sywac
```

Provides the command `create-sywac`.

## 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.2.1 |
| Published | 2020-05-16 |
| First published | 2018-12-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 6 |
| Unpacked size | 15.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | nexdrew |
| Maintainers | nexdrew |
| Keywords | init, initialize, cli, project, scaffold, generate, generator |

## Links

- npm: https://www.npmjs.com/package/create-sywac
- Repository: https://github.com/sywac/create-sywac
- Homepage: https://github.com/sywac/create-sywac#readme
- Issues: https://github.com/sywac/create-sywac/issues
- npm.io page: https://npm.io/package/create-sywac

## Dependencies (6)

- [execa](https://npm.io/package/execa.md) ^4.0.1
- [sywac](https://npm.io/package/sywac.md) ^1.3.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4
- [figures](https://npm.io/package/figures.md) ^3.2.0
- [log-update](https://npm.io/package/log-update.md) ^4.0.0
- [sywac-style-basic](https://npm.io/package/sywac-style-basic.md) ^2.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.2.1 (latest) — 2020-05-16
- 0.2.0 — 2018-12-31
- 0.1.1 — 2018-12-30
- 0.1.0 — 2018-12-30

## README

# create-sywac

> npm init sywac

[![Build Status](https://travis-ci.com/sywac/create-sywac.svg?branch=master)](https://travis-ci.com/sywac/create-sywac)
[![JavaScript Style Guide](https://badgen.net/badge/code%20style/standard/green)](https://standardjs.com)
![Dependabot Badge](https://badgen.net/dependabot/sywac/create-sywac?icon=dependabot)

This package is used to scaffold your sywac-powered CLI project when you run `npm init sywac`.

For information about sywac, visit https://sywac.io

## Recommended Usage

To create a project from scratch:

```console
$ mkdir <project>
$ cd <project>
$ git init
$ git remote add origin <blah>
$ npm init
$ npm init sywac --all
```

To just add sywac to an existing project:

```console
$ cd <project>
$ npm init sywac
```

To see all options:

```console
$ npm init sywac -- --help
```

## Details

This tool sets up the following:

- Makes sure the project directory exists, if specified via `npm init sywac <dir>`
- Creates an executable `cli.js` file, if missing
- Creates or modifies a `package.json` file:
  - Adds `sywac` and `sywac-style-basic` as production dependencies, if missing
  - Defines `"bin"` to be `"cli.js"`, if not defined
  - Optionally defines `"main"` to be `"index.js"`, if not defined
  - Optionally adds `"cli.js"` and `"index.js"` to `"files"`, if missing
  - Optionally adds dev dependencies, if missing:
    - `coveralls`
    - `standard`
    - `standard-version`
    - `tap`
  - Optionally adds scripts, if missing:
    - `"pretest": "standard"`
    - `"test": "tap --cov test.js"`
    - `"coverage": "nyc report --reporter=text-lcov | coveralls"`
    - `"release": "standard-version"`
- Optionally creates a default `.gitignore` file, if missing
- Optionally creates a default `.npmrc` file, if missing
- Optionally creates a default `.travis.yml` file, if missing
- Optionally creates a default ISC `LICENSE` file, if missing
- Optionally creates a default `README.md` file, if missing
- Optionally creates an empty `index.js` file, if missing
- Optionally creates an empty `test.js` file, if missing

## License

MIT © Andrew Goode

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