# create-nvmrc

> A GitHub action that commits an .nvmrc file to your repository that can also be used as an npm module or cli.

Latest version **0.1.1** (published 2020-05-01) · MIT license · 0 weekly downloads

## Install

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

Provides the command `create-nvmrc`.

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2020-05-01 |
| First published | 2020-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 119.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rik Hoffbauer |
| Maintainers | rik.hoffbauer |
| Keywords | nvmrc, init, init-actions, github, github-action, create, .nvmrc, npm, version |

## Links

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

## Dependencies (9)

- [got](https://npm.io/package/got.md) ^11.0.2
- [fasy](https://npm.io/package/fasy.md) ^7.0.1
- [js-yaml](https://npm.io/package/js-yaml.md) ^3.13.1
- [nodegit](https://npm.io/package/nodegit.md) ^0.26.5
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.0
- [@actions/core](https://npm.io/package/@actions/core.md) ^1.2.0
- [@types/js-yaml](https://npm.io/package/@types/js-yaml.md) ^3.12.3
- [@types/nodegit](https://npm.io/package/@types/nodegit.md) ^0.26.2
- [@actions/github](https://npm.io/package/@actions/github.md) ^1.1.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2020-05-01
- 0.1.0 — 2020-04-30

## README

<h1 align="center">Welcome to create-nvmrc 👋</h1>
<p>
  <img alt="Version" src="https://img.shields.io/badge/version-0.0.0-blue.svg?cacheSeconds=2592000" />
  <a href="https://init-actions.github.io/nvmrc" target="_blank">
    <img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
  </a>
  <a href="https://github.com/init-actions/nvmrc/graphs/commit-activity" target="_blank">
    <img alt="Maintenance" src="https://img.shields.io/badge/Maintained%3F-yes-green.svg" />
  </a>
  <a href="https://github.com/init-actions/nvmrc/blob/master/LICENSE" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/github/license/init-actions/nvmrc" />
  </a>
</p>

> A GitHub action that commits an .nvmrc file to your repository that can also be used as an npm module or cli.

### 🏠 [Homepage](https://github.com/init-actions/nvmrc#readme)

## Install

```sh
npm install create-nvmrc
```

## Usage

```typescript
import { createNvmrcFile } from "create-nvmrc";

createNvmrcFile("/path/to/.nvmrc", "v12.16.3", true)
    .then(() => console.log("created"))
    .catch(err => console.log("failed", err));

createNvmrcFile("/path/to/.nvmrc", "12.16.3", true)
    .then(() => console.log("created"))
    .catch(err => console.log("failed", err));

createNvmrcFile("/path/to/.nvmrc", "lts", true)
    .then(() => console.log("created"))
    .catch(err => console.log("failed", err));

createNvmrcFile("/path/to/.nvmrc", "current", true)
    .then(() => console.log("created"))
    .catch(err => console.log("failed", err));
```

## Run tests

```sh
npm run test
```

## Author

👤 **Rik Hoffbauer <62353999+rikhoffbauer@users.noreply.github.com> (rikhoffbauer.github.io)**

-   Website: https://rikhoffbauer.github.io
-   Github: [@rikhoffbauer](https://github.com/rikhoffbauer)
-   LinkedIn: [@rikhoffbauer](https://linkedin.com/in/rikhoffbauer)

## 🤝 Contributing

Contributions, issues and feature requests are welcome!<br />Feel free to check [issues page](https://github.com/init-actions/nvmrc/issues). You can also take a look at the [contributing guide](https://github.com/init-actions/nvmrc/blob/master/CONTRIBUTING.md).

## Show your support

Give a ⭐️ if this project helped you!

<a href="https://www.patreon.com/rikhoffbauer">
  <img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" width="160">
</a>

## 📝 License

Copyright © 2020 [Rik Hoffbauer <62353999+rikhoffbauer@users.noreply.github.com> (rikhoffbauer.github.io)](https://github.com/rikhoffbauer).<br /> This project is [MIT](https://github.com/init-actions/nvmrc/blob/master/LICENSE) licensed.

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