Targets	Requires	Variables
`project` `├─ .circleci` `│ └─ config.yml` `├─ .dependabot` `│ └─ config.yml` `├─ .idea` `│ └─ ${projectName}.iml` `├─ .c8rc.json` `├─ .editorconfig` `├─ eslint.config.js` `├─ .eslintrc.json` `├─ .gally.json` `├─ gardener.js` `├─ .gitignore` `├─ LICENSE` `├─ .mocharc.yml` `├─ .npmignore` `├─ package.json` `├─ README.md` `├─ .releaserc.json` `├─ src` `│ └─ index.js` `└─ test` `├─ hot.js` `├─ index.spec.js` `└─ reg.js`	javascript js-gardener mocha chai eslint semantic-release npm npm-published jetbrains c8 git circleci gally github dependabot yarn	packageName nccExclude nccEnabled nodeVersion repoKey ownerName projectName owner mergeBot

## :open_file_folder: struct/#npm-default (`index`) Manage basic project structure for npm package on github.

Targets	Requires	Variables
`project` `├─ eslint.config.js` `├─ .eslintrc.json` `├─ gardener.js` `├─ .mocharc.yml` `├─ README.md` `├─ src` `│ └─ index.js` `└─ test` `├─ hot.js` `├─ index.spec.js` `└─ reg.js`	javascript js-gardener mocha chai eslint	packageName

### :clipboard: struct/force-gardener (`index`) _Updating gardener.js using overwrite._ - Manage gardener.js file for js-gardener.

Targets	Requires
`project` `└─ gardener.js`	javascript js-gardener

### :open_file_folder: struct/#npm-base (`index`) Manage basic project structure for npm package on github.

Targets	Requires	Variables
`project` `├─ eslint.config.js` `├─ .eslintrc.json` `├─ .mocharc.yml` `├─ README.md` `├─ src` `│ └─ index.js` `└─ test` `├─ hot.js` `├─ index.spec.js` `└─ reg.js`	javascript mocha chai eslint	packageName

#### :clipboard: struct/test-reg (`index`) _Updating test/reg.js using overwrite._ - Create register file.

Targets	Requires
`project` `└─ test` `└─ reg.js`	javascript

#### :clipboard: struct/test-hot (`index`) _Updating test/hot.js using overwrite._ - Create loader file.

Targets	Requires
`project` `└─ test` `└─ hot.js`	javascript

#### :clipboard: struct/template-readme (`index`) _Updating README.md using create-only._ - Create README.md template file.

Targets	Variables
`project` `└─ README.md`	packageName

#### :clipboard: struct/template-mocharc (`index`) _Updating .mocharc.yml using create-only._ - Create options file for mocha tests.

Targets	Requires
`project` `└─ .mocharc.yml`	javascript mocha

#### :clipboard: struct/template-index-test (`index`) _Updating test/index.spec.js using create-only._ - Create package template index.spec.js test file.

Targets	Requires
`project` `└─ test` `└─ index.spec.js`	javascript chai

#### :clipboard: struct/template-index (`index`) _Updating src/index.js using create-only._ - Create package template index.js file.

Targets	Requires
`project` `└─ src` `└─ index.js`	javascript

#### :clipboard: struct/template-eslintrc (`index`) _Updating .eslintrc.json using overwrite._ - Create configuration file for eslint enforcing opinionated, best practices.

Targets	Requires
`project` `└─ .eslintrc.json`	javascript eslint

#### :clipboard: struct/template-eslint-config (`index`) _Updating eslint.config.js using overwrite._ - Create configuration file for eslint enforcing opinionated, best practices.

Targets	Requires
`project` `└─ eslint.config.js`	javascript eslint

## :open_file_folder: semantic-release/#npm-default (`index`) Manage semantic-release configuration for npm package on github.

Targets	Requires
`project` `└─ .releaserc.json`	semantic-release

### :clipboard: semantic-release/commit-conventions (`index`) _Updating .releaserc.json using overwrite._ - Slightly extended [release commit convention](https://github.com/semantic-release/semantic-release#commit-message-format) for semantic-release.

Targets	Requires
`project` `└─ .releaserc.json`	semantic-release

## :open_file_folder: package/#npm-default (`index`) Manage package.json for npm package on github.

Targets	Requires	Variables
`project` `└─ package.json`	javascript	nccExclude nccEnabled nodeVersion repoKey packageName

### :clipboard: package/npm-default_merge-shallow (`index`) _Updating package.json using merge-shallow._ - Set various entries.

Targets	Requires	Variables
`project` `└─ package.json`	javascript	nccExclude nccEnabled

### :clipboard: package/npm-default_merge-deep (`index`) _Updating package.json using merge-deep._ - Set various entries.

Targets	Requires	Variables
`project` `└─ package.json`	javascript	nodeVersion repoKey packageName

### :clipboard: package/npm-default_default-shallow (`index`) _Updating package.json using default-shallow._ - Set defaults for various entries.

Targets	Requires
`project` `└─ package.json`	javascript

### :clipboard: package/npm-default_default-deep (`index`) _Updating package.json using default-deep._ - Set defaults for various entries.

Targets	Requires
`project` `└─ package.json`	javascript

## :open_file_folder: npm/#npm-default (`index`) Manage npm configuration for npm package on github.

Targets	Requires
`project` `└─ .npmignore`	npm npm-published

### :clipboard: npm/npmignore (`index`) _Updating .npmignore using unique-top._ - Inject comment into .npmignore explaining when to use it.

Targets	Requires
`project` `└─ .npmignore`	npm npm-published

## :open_file_folder: license/#opensource (`index`) Manage license configuration for open source project.

Targets	Requires	Variables
`project` `├─ LICENSE` `└─ package.json`	npm	ownerName repoKey

### :clipboard: license/MIT-package (`index`) _Updating package.json using merge-shallow._ - Link MIT license file into [npm](https://www.npmjs.com/) configuration.

Targets	Requires	Variables
`project` `└─ package.json`	npm	ownerName repoKey

### :clipboard: license/MIT-file (`index`) _Updating LICENSE using overwrite._ - Generate [MIT license](https://en.wikipedia.org/wiki/MIT_License) file.

Targets	Variables
`project` `└─ LICENSE`	ownerName

## :open_file_folder: jetbrains/#default (`index`) Manage WebStorm configuration.

Targets	Requires	Variables
`project` `└─ .idea` `└─ ${projectName}.iml`	jetbrains c8	projectName

### :clipboard: jetbrains/exclude-coverage-folder (`index`) _Updating .idea/${projectName}.iml (if exists) using xml-merge._ - Mark `coverage` Folder as excluded in Jetbrains.

Targets	Requires	Variables
`project` `└─ .idea` `└─ ${projectName}.iml`	jetbrains c8	projectName

## :open_file_folder: gitignore/#npm-default (`index`) Manage gitignore configuration for npm package on github.

Targets	Requires
`project` `└─ .gitignore`	git

### :clipboard: gitignore/npm-default (`index`) _Updating .gitignore using unique-top._ - Inject recommended entries into [gitignore file](https://help.github.com/en/articles/ignoring-files). - Default ignores for JetBrains IDE. - Default ignores for OSX - Default ignores for NodeJs

Targets	Requires
`project` `└─ .gitignore`	git

## :open_file_folder: gally/#npm-default (`index`) Manage gally configuration for npm package on github.

Targets	Requires	Variables
`project` `└─ .gally.json`	circleci gally github	owner mergeBot repoKey

### :clipboard: gally/two-branch (`index`) _Updating .gally.json using overwrite._ - Restrictive two-branch config.

Targets	Requires	Variables
`project` `└─ .gally.json`	circleci gally github	owner mergeBot repoKey

## :open_file_folder: editor/#default (`index`) Manage editor configuration for project.

Targets
`project` `└─ .editorconfig`

### :clipboard: editor/two-space (`index`) _Updating .editorconfig using overwrite._ - Two space line indentation. - Set `lf` line endings. - Set `utf8` encoding. - Remove unnecessary whitespaces.

Targets
`project` `└─ .editorconfig`

## :open_file_folder: dependabot/#npm-default (`index`) Manage dependabot configuration for npm package on github.

Targets	Requires
`project` `└─ .dependabot` `└─ config.yml`	dependabot github javascript

### :clipboard: dependabot/js-instant (`index`) _Updating .dependabot/config.yml using overwrite._ - Configure dependabot to instantly merge javascript dependency updates into the `dev` branch.

Targets	Requires
`project` `└─ .dependabot` `└─ config.yml`	dependabot github javascript

## :open_file_folder: circleci/#npm-default (`index`) Manage circleci configuration for npm package on github.

Targets	Requires
`project` `└─ .circleci` `└─ config.yml`	npm yarn gally github circleci dependabot semantic-release

### :clipboard: circleci/two-branch (`index`) _Updating .circleci/config.yml using overwrite._ - Restrictive two-branch circleci config.

Targets	Requires
`project` `└─ .circleci` `└─ config.yml`	npm yarn gally github circleci dependabot semantic-release

## :open_file_folder: c8/#default (`index`) Manage .c8rc.json for c8 coverage testing.

Targets	Requires
`project` `└─ .c8rc.json`	javascript

### :clipboard: c8/default_merge-shallow (`index`) _Updating .c8rc.json using merge-shallow._ - Set various entries.

Targets	Requires
`project` `└─ .c8rc.json`	javascript

### :clipboard: c8/default_merge-deep (`index`) _Updating .c8rc.json using merge-deep._ - Set various entries.

Targets	Requires
`project` `└─ .c8rc.json`	javascript

### :clipboard: c8/default_default-shallow (`index`) _Updating .c8rc.json using default-shallow._ - Set defaults for various entries.

Targets	Requires
`project` `└─ .c8rc.json`	javascript

### :clipboard: c8/default_default-deep (`index`) _Updating .c8rc.json using default-deep._ - Set defaults for various entries.

Targets	Requires
`project` `└─ .c8rc.json`	javascript

## :open_file_folder: badges/#npm-opensource (`index`) Add badged for npm open source package on github.

Targets	Requires	Variables
`project` `└─ README.md`	npm-published circleci	packageName repoKey

### :clipboard: badges/npm-status (`index`) _Updating README.md using merge-below-title._ - Display [npm status](https://www.npmjs.com/) badge in README.

Targets	Requires	Variables
`project` `└─ README.md`	npm-published	packageName

### :clipboard: badges/npm-downloads (`index`) _Updating README.md using merge-below-title._ - Display [npm downloads](https://www.npmjs.com/) badge in README.

Targets	Requires	Variables
`project` `└─ README.md`	npm-published	packageName

### :clipboard: badges/circleci (`index`) _Updating README.md using merge-below-title._ - Display [circleci](https://circleci.com/) badge in README.

Targets	Requires	Variables
`project` `└─ README.md`	circleci	repoKey

------ ## Requires ### javascript ([`link`](https://en.wikipedia.org/wiki/JavaScript)) *Programming Language.* JavaScript, often abbreviated as JS, is a high-level, interpreted programming language that conforms to the ECMAScript specification. It is characterized as dynamic, weakly typed, prototype-based and multi-paradigm. ### js-gardener ([`link`](https://github.com/blackflux/js-gardener#readme)) *NodeJs Project Management.* Enforces and helps setting up best practices around NodeJs projects. Enforces highest code quality and minimizes package setup and maintenance complexity - so you can focus on writing code. Highly recommended if you are getting started with a new package and extremely useful if you are maintaining multiple packages. ### mocha ([`link`](https://mochajs.org/)) *JavaScript test framework.* Mocha is a JavaScript test framework for Node.js programs, featuring browser support, asynchronous testing, test coverage reports, and use of any assertion library. ### chai ([`link`](https://www.chaijs.com/)) *JavaScript assertion library.* Chai is a BDD / TDD assertion library for node and the browser that can be paired with any javascript testing framework. ### eslint ([`link`](https://eslint.org/)) *Linting for JavaScript.* JSLint is a static code analysis tool used in software development for checking if JavaScript source code complies with coding rules. ### semantic-release ([`link`](https://github.com/semantic-release/semantic-release)) *Automates npm package release workflow.* Automates the package release workflow including: - determining the next version number - generating the release notes - publishing the package ### npm ([`link`](https://docs.npmjs.com/about-npm/)) *Javascript package repository.* Requires the project to be conform with the npm standard, i.e. contain a package.json file. Does not require the project to be published to npm. ### npm-published ([`link`](https://docs.npmjs.com/about-npm/)) *Javascript package repository published.* Requires the project to be published to npm either as a private or public package. ### jetbrains ([`link`](https://www.jetbrains.com)) *Collection of various IDEs.* Collection of various IDEs. There exists one for every major programming language and they are all very similar (i.e. shortcuts, layout), which makes them great when switching languages. ### c8 ([`link`](https://github.com/bcoe/c8)) *Coverage testing for javascript projects.* A major coverage testing framework for javascript. Comes with all the bells and whistles. ### git ([`link`](https://git-scm.com/)) *Version control system.* The most used version control system. Not to be confused with github (which uses git). ### circleci ([`link`](https://circleci.com/)) *Run automated jobs using docker containers.* Allows set up for ci/cd using docker containers. Automates development process quickly, safely, and at scale. ### gally ([`link`](https://github.com/loopmediagroup/gally)) *Automation around github.com Repository Management* Allows management of github.com repositories through configuration. Very powerful when you need to synchronize settings across multiple repositories. ### github ([`link`](https://github.com/)) *Major development platform powered by git.* GitHub is a code hosting platform for collaboration and version control. Lets you and others work together on projects. ### dependabot ([`link`](https://dependabot.com/)) *Automatic dependency updates.* Makes dependency updates very easy by automatically creating pull requests in your repo. All major programming languages are supported or work is done towards supporting them. ### yarn ([`link`](https://yarnpkg.com/)) *Dependency management similar to npm.* Very similar functionality to npm cli. ------ ## Variables ### packageName : `string` *Name of the package on npm.* The name of the project as published to npm. Note that for scoped packages the name can differ significantly from the repo name. ### nccExclude : `array` **Default**: `` *Exclude packages from ncc compilation.* ### nccEnabled : `boolean` *Enable ncc for service.* Uses NCC to compile service. Please ensure that the service still works after ncc compilation. ### nodeVersion : `string` *The minimum node version targeted.* The minimum nodejs version that the project targets. ### repoKey : `string` *Repository key.* The repository key contains the owner or organization of the project and the repository name itself, separated by a slash. ### ownerName : `string` *Name of the owner of this project.* The owner name of the project is the name of the person or organization publishing the project under their license. ### projectName : `string` *Name of the project.* The project name is in most cases identical to the repository name. ### owner : `string` *The owner of the code on github.* The code owner is the gatekeeper of the project, ultimately responsible for all changes. ### mergeBot : `string` *The github name of the bot used for automatic merging.* ------ ## Targets ### gardener.js ([`link`](https://github.com/blackflux/js-gardener#run-basic-setup)) :small_red_triangle: js-gardener, javascript :small_blue_diamond: `other` *Runner for js-gardener.* Execute all configured js-gardener tasks. ### test/reg.js :small_blue_diamond: `other` *Registration hook to load custom loader.* ### test/hot.js :small_blue_diamond: `other` *Loader to allow hot reloading of files for testing.* ### README.md ([`link`](https://help.github.com/en/articles/about-readmes)) :small_blue_diamond: `nostruct` *Project readme file.* Contains lots of information about the project itself. ### .mocharc.yml ([`link`](https://mochajs.org/#mochaopts)) :small_red_triangle: mocha, javascript :small_blue_diamond: `list` *Mocha test configuration file.* ### test/index.spec.js :small_red_triangle: javascript :small_blue_diamond: `other` *Main project test file.* Main test file for the project. At the very least tests signature of what is exposed. ### src/index.js :small_red_triangle: javascript :small_blue_diamond: `other` *Main project file.* Main file for the project. Exposes functionality for libraries. ### .eslintrc.json ([`link`](https://eslint.org/docs/user-guide/configuring)) :small_red_triangle: eslint :small_blue_diamond: `json` *Configuration file for eslint.* ### eslint.config.js ([`link`](https://eslint.org/docs/latest/use/configure/configuration-files-new)) :small_red_triangle: eslint :small_blue_diamond: `nostruct` *Configuration file for eslint.* ### .releaserc.json ([`link`](https://semantic-release.gitbook.io/semantic-release/usage/configuration#configuration-file)) :small_red_triangle: semantic-release :small_blue_diamond: `json` *Configuration for semantic-release.* Configuration file for semantic-release and plugins ### package.json ([`link`](https://docs.npmjs.com/files/package.json)) :small_red_triangle: npm :small_blue_diamond: `json` *Configuration for npm package.* ### .npmignore ([`link`](https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package)) :small_red_triangle: npm, npm-published :small_blue_diamond: `list` *Config to exclude files from npm package.* Note that this file is mostly not required. Use whitelisting instead. See [here](https://medium.com/@jdxcode/for-the-love-of-god-dont-use-npmignore-f93c08909d8d) for more information. ### LICENSE ([`link`](https://help.github.com/en/articles/adding-a-license-to-a-repository)) :small_blue_diamond: `nostruct` *Project License file.* Specify the license the project is published under. Can be set to unlicensed as well. ### .idea/${projectName}.iml ([`link`](https://www.jetbrains.org/intellij/sdk/docs/basics/project_structure.html#library)) :small_red_triangle: jetbrains :small_blue_diamond: `xml` *Module Library configuration file for JetBrains IDE.* ### .gitignore ([`link`](https://git-scm.com/docs/gitignore)) :small_red_triangle: git :small_blue_diamond: `list` *Exclude files from being tracked.* Specifies files intentionally untracked by git. ### .gally.json ([`link`](https://github.com/loopmediagroup/gally#contents-of-gallyjson)) :small_red_triangle: gally, github :small_blue_diamond: `json` *Configuration file for gally.* Includes detailed configuration for github project structure. ### .editorconfig ([`link`](https://editorconfig.org/)) :small_blue_diamond: `other` *Defines file formatting.* Defines file formatting that an IDE can pick up and use to format project files. ### .dependabot/config.yml ([`link`](https://dependabot.com/docs/config-file/)) :small_red_triangle: dependabot :small_blue_diamond: `yml` *Configuration file for dependabot.* ### .circleci/config.yml ([`link`](https://circleci.com/docs/2.0/configuration-reference/)) :small_red_triangle: circleci :small_blue_diamond: `yml` *Configuration file for circleci.* ### .c8rc.json ([`link`](https://github.com/bcoe/c8)) :small_red_triangle: c8 :small_blue_diamond: `json` *Configuration for c8 package.* ------ ## Strategies ### overwrite :small_blue_diamond: `any` *Simply replace the old with the new content.* ### create-only :small_blue_diamond: `any` *Does nothing when the file is already present, otherwise creates it.* ### merge-shallow :small_blue_diamond: `json`, `yml` *Does a shallow merge aka `Object.assign()`.* Useful when specific keys of the target need to be overwritten. ### merge-deep :small_blue_diamond: `json`, `yml` *Does a "smart" deep merge.* This will not work as desired for all object deep merging, but should for many cases. ### default-shallow :small_blue_diamond: `json`, `yml` *Similar to `merge-shallow`, but keeps existing values instead of overwriting.* Useful to ensure specific keys of the target are present without overwriting existing content. ### default-deep :small_blue_diamond: `json`, `yml` *Similar to `merge-deep`, but keeps existing values instead of overwriting.* Useful to ensure specific keys of the target are present without overwriting existing content. ### unique-top :small_blue_diamond: `list` *Merges content at the top of the file and removes existing, duplicate lines.* Useful for managing e.g. `.gitignore` when the original content should be kept. ### xml-merge :small_blue_diamond: `xml` *Does a "smart" deep merge.* This will not work as desired for all xml merging, but should for many cases. ### merge-below-title :small_blue_diamond: `list`, `nostruct` *Merges content below title.*