# underscores-gen

> Generator based on Underscores Theme for Wordpress

Latest version **1.0.5** (published 2021-10-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install underscores-gen
pnpm add underscores-gen
yarn add underscores-gen
bun add underscores-gen
```

Provides the command `underscores-gen`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2021-10-13 |
| First published | 2021-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | icaliman |
| Maintainers | icaliman |
| Keywords | underscores, _s, theme, wordpress, starter, sass |

## Links

- npm: https://www.npmjs.com/package/underscores-gen
- Repository: https://github.com/icaliman/underscores-gen
- Homepage: https://github.com/icaliman/underscores-gen#readme
- Issues: https://github.com/icaliman/underscores-gen/issues
- npm.io page: https://npm.io/package/underscores-gen

## Dependencies (5)

- [etl](https://npm.io/package/etl.md) ^0.6.12
- [prompts](https://npm.io/package/prompts.md) ^2.4.2
- [slugify](https://npm.io/package/slugify.md) ^1.6.1
- [download](https://npm.io/package/download.md) ^8.0.0
- [unzipper](https://npm.io/package/unzipper.md) ^0.10.11

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 1.0.5 (latest) — 2021-10-13
- 1.0.4 — 2021-10-13
- 1.0.3 — 2021-10-12
- 1.0.2 — 2021-10-12
- 1.0.1 — 2021-10-12
- 1.0.0 — 2021-10-12

## README

# Generator based on [_s theme](https://github.com/automattic/_s)


Hi. Want to develop a WordPress theme and are looking for a good starter theme? That's what I'm here for. I'm a generator for the starter theme called `_s`, or `underscores`, if you like.

Installation
---------------

### Requirements

`_s` requires the following dependencies:

- [Node.js](https://nodejs.org/)
- [Composer](https://getcomposer.org/)

### Quick Start

#### 1 - Generate
Open the Terminal inside the WordPress `themes` directory and run the folowing commands:

```sh
$ cd /path/to/wp-content/themes
$ npx underscores-gen
```

You will be prompted to enter the theme name, slug and path.

#### 2 - Setup
To start using all the tools that come with `_s`  you need to install the necessary Node.js and Composer dependencies:

```sh
$ cd theme-dir
$ composer install
$ npm install
```

### Available CLI commands

`_s` comes packed with CLI commands tailored for WordPress theme development :

- `composer lint:wpcs` : checks all PHP files against [PHP Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/).
- `composer lint:php` : checks all PHP files for syntax errors.
- `composer make-pot` : generates a .pot file in the `languages/` directory.
- `npm run compile:css` : compiles SASS files to css.
- `npm run compile:rtl` : generates an RTL stylesheet.
- `npm run watch` : watches all SASS files and recompiles them to css when they change.
- `npm run lint:scss` : checks all SASS files against [CSS Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/css/).
- `npm run lint:js` : checks all JavaScript files against [JavaScript Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/javascript/).
- `npm run bundle` : generates a .zip archive for distribution, excluding development and system files.

### Setup Visual Studio Code

1. Open Visual Studio Code.
2. Press `Ctrl+P` on Windows or `Cmd+P` on Mac to open the Quick Open dialog.
3. Type `ext install phpsab` to find the extension.
4. Press Enter or click the cloud icon to install it.
5. Restart Visual Studio Code!

Now you're ready to go! The next step is easy to say, but harder to do: make an awesome WordPress theme. :)

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