From 2f010367868a8638e95ba5bc942517907a93c016 Mon Sep 17 00:00:00 2001 From: Michael Taranto Date: Sat, 20 Oct 2018 07:39:43 +1100 Subject: [PATCH] chore(packageName): Rename to allow npm publish (#2) --- README.md | 16 ++++++++-------- package.json | 8 ++++---- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 286f3a2..6620a30 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -[![Build Status](https://img.shields.io/travis/seek-oss/gitignore-ensure/master.svg?style=flat-square)](http://travis-ci.org/seek-oss/gitignore-ensure) [![npm](https://img.shields.io/npm/v/gitignore-ensure.svg?style=flat-square)](https://www.npmjs.com/package/gitignore-ensure) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/) +[![Build Status](https://img.shields.io/travis/seek-oss/ensure-gitignore/master.svg?style=flat-square)](http://travis-ci.org/seek-oss/ensure-gitignore) [![npm](https://img.shields.io/npm/v/ensure-gitignore.svg?style=flat-square)](https://www.npmjs.com/package/ensure-gitignore) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square)](http://commitizen.github.io/cz-cli/) -# gitignore-ensure +# ensure-gitignore Ensure the presence of patterns within a project's gitignore. ## Usage ```js -const gitignoreEnsure = require('gitignore-ensure'); +const ensureGitignore = require('ensure-gitignore'); -await gitignoreEnsure({ +await ensureGitignore({ patterns: ['node_modules', 'output'] }); ``` @@ -31,9 +31,9 @@ An array of patterns to ensure are present in the specified `.gitignore` file. A Appended to each pattern that is being ensured to indicate what is programmatically being controlled. ```js -const gitignoreEnsure = require('gitignore-ensure'); +const ensureGitignore = require('ensure-gitignore'); -await gitignoreEnsure({ +await ensureGitignore({ patterns: ['node_modules', 'output'], comment: 'managed' }); @@ -49,9 +49,9 @@ await gitignoreEnsure({ The file at the input path will not be updated, instead the intended output will be returned. ```js -const gitignoreEnsure = require('gitignore-ensure'); +const ensureGitignore = require('ensure-gitignore'); -const result = await gitignoreEnsure({ +const result = await ensureGitignore({ patterns: ['node_modules', 'output'], dryRun: true }); diff --git a/package.json b/package.json index d2e8d40..1dcda11 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "gitignore-ensure", + "name": "ensure-gitignore", "version": "0.0.0-development", "description": "Ensure the presence of patterns within a project's gitignore", "main": "index.js", @@ -26,14 +26,14 @@ }, "repository": { "type": "git", - "url": "https://github.com/seek-oss/gitignore-ensure.git" + "url": "https://github.com/seek-oss/ensure-gitignore.git" }, "author": "SEEK", "license": "MIT", "bugs": { - "url": "https://github.com/seek-oss/gitignore-ensure/issues" + "url": "https://github.com/seek-oss/ensure-gitignore/issues" }, - "homepage": "https://github.com/seek-oss/gitignore-ensure#readme", + "homepage": "https://github.com/seek-oss/ensure-gitignore#readme", "devDependencies": { "@commitlint/cli": "^7.2.1", "commitizen": "^3.0.2",