Targets	Requires	Variables
`project` `├─ .circleci` `│ └─ config.yml` `├─ .github` `│ └─ ISSUE_TEMPLATE` `│ ├─ bug_report.md` `│ └─ feature_request.md` `├─ .idea` `│ └─ ${projectName}.iml` `├─ .c8rc.json` `├─ .editorconfig` `├─ eslint.config.js` `├─ .eslintrc.json` `├─ .gally.json` `├─ gardener.js` `├─ .gitignore` `├─ LICENSE` `├─ manage.sh` `├─ .mocharc.yml` `├─ package.json` `├─ README.md` `├─ docker` `│ └─ Dockerfile` `├─ serverless` `│ ├─ .base` `│ │ ├─ api.yml` `│ │ ├─ data-stack-hash.js` `│ │ ├─ data.yml` `│ │ ├─ resolver.js` `│ │ └─ resolver.yml` `│ ├─ api.yml` `│ ├─ compile.js` `│ ├─ data.yml` `│ ├─ pkg.js` `│ └─ api` `│ └─ random-deploy-hash.js` `├─ src` `│ └─ core` `│ └─ aws.js` `└─ test` `├─ 0-sls-cf-stack.spec.js` `├─ 4-deps.spec.js` `├─ 7-sls-tags.spec.js` `├─ hot.js` `├─ lib-test.sh` `├─ reg.js` `└─ sls-cf-stack-routes.yml`	javascript mocha eslint github js-gardener serverless aws npm jetbrains c8 git circleci gally docker yarn dependabot semantic-release	awsRegion nccExclude namespace slsEndpointType projectName nccEnabled nodeVersion repoKey ownerName owner mergeBot circleCiReadToken

## :open_file_folder: struct/#serverless (`index`) Manage basic project structure for serverless project.

Targets	Requires
`project` `├─ .github` `│ └─ ISSUE_TEMPLATE` `│ ├─ bug_report.md` `│ └─ feature_request.md` `├─ eslint.config.js` `├─ .eslintrc.json` `├─ gardener.js` `├─ .mocharc.yml` `└─ test` `├─ hot.js` `└─ reg.js`	javascript mocha eslint github js-gardener

### :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-mocharc (`index`) _Updating .mocharc.yml using create-only._ - Create options file for mocha tests.

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

### :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

### :clipboard: struct/github-feature-request (`index`) _Updating .github/ISSUE_TEMPLATE/feature_request.md using create-only._ - Generate Github Feature Request template.

Targets	Requires
`project` `└─ .github` `└─ ISSUE_TEMPLATE` `└─ feature_request.md`	github

### :clipboard: struct/github-bug-report (`index`) _Updating .github/ISSUE_TEMPLATE/bug_report.md using create-only._ - Generate Github Bug Report template.

Targets	Requires
`project` `└─ .github` `└─ ISSUE_TEMPLATE` `└─ bug_report.md`	github

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

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

## :open_file_folder: serverless/#two-stack (`index`) Manage serverless configuration for deployment to AWS.

Targets	Requires	Variables
`project` `├─ serverless` `│ ├─ .base` `│ │ ├─ api.yml` `│ │ ├─ data-stack-hash.js` `│ │ ├─ data.yml` `│ │ ├─ resolver.js` `│ │ └─ resolver.yml` `│ ├─ api.yml` `│ ├─ compile.js` `│ ├─ data.yml` `│ ├─ pkg.js` `│ └─ api` `│ └─ random-deploy-hash.js` `├─ src` `│ └─ core` `│ └─ aws.js` `└─ test` `├─ 0-sls-cf-stack.spec.js` `├─ 4-deps.spec.js` `├─ 7-sls-tags.spec.js` `├─ lib-test.sh` `└─ sls-cf-stack-routes.yml`	serverless aws javascript	awsRegion nccExclude namespace slsEndpointType projectName nccEnabled

### :clipboard: serverless/test-sls-tags (`index`) _Updating test/7-sls-tags.spec.js using overwrite._ - Test to enforce resources tagging.

Targets	Requires
`project` `└─ test` `└─ 7-sls-tags.spec.js`	serverless aws

### :clipboard: serverless/test-sls-cf-stack-routes (`index`) _Updating test/sls-cf-stack-routes.yml using create-only._ - Used in tests to ensure sls configuration consistency.

Targets	Requires
`project` `└─ test` `└─ sls-cf-stack-routes.yml`	serverless aws

### :clipboard: serverless/test-sls-cf-stack (`index`) _Updating test/0-sls-cf-stack.spec.js using overwrite._ - Test to visualize sls cf stack definition.

Targets	Requires	Variables
`project` `└─ test` `└─ 0-sls-cf-stack.spec.js`	serverless aws	awsRegion

### :clipboard: serverless/test-lib-test (`index`) _Updating test/lib-test.sh using overwrite._ - Script for doing integration test against lib folder.

Targets	Requires
`project` `└─ test` `└─ lib-test.sh`	serverless aws

### :clipboard: serverless/test-deps (`index`) _Updating test/4-deps.spec.js using overwrite._ - Test to enforce resources tagging.

Targets	Requires
`project` `└─ test` `└─ 4-deps.spec.js`	serverless aws

### :clipboard: serverless/src-core-aws (`index`) _Updating src/core/aws.js using create-only._ - Create aws sdk initialization file.

Targets	Requires
`project` `└─ src` `└─ core` `└─ aws.js`	javascript

### :clipboard: serverless/serverless-pkg (`index`) _Updating serverless/pkg.js using overwrite._ - Create file that created package.json related files in lib folder.

Targets	Requires	Variables
`project` `└─ serverless` `└─ pkg.js`	serverless aws	nccExclude

### :clipboard: serverless/serverless-data (`index`) _Updating serverless/data.yml using create-only._ - Initialize data stack resource definition file.

Targets	Requires
`project` `└─ serverless` `└─ data.yml`	serverless aws

### :clipboard: serverless/serverless-compile (`index`) _Updating serverless/compile.js using overwrite._ - Create file that compiles serverless configuration to yml.

Targets	Requires
`project` `└─ serverless` `└─ compile.js`	serverless aws

### :clipboard: serverless/serverless-base-resolver-js (`index`) _Updating serverless/.base/resolver.js using overwrite._ - Create serverless stack resolver js configuration file.

Targets	Requires
`project` `└─ serverless` `└─ .base` `└─ resolver.js`	serverless aws

### :clipboard: serverless/serverless-base-resolver (`index`) _Updating serverless/.base/resolver.yml using overwrite._ - Create serverless stack resolver configuration file.

Targets	Requires	Variables
`project` `└─ serverless` `└─ .base` `└─ resolver.yml`	serverless aws	namespace slsEndpointType projectName

### :clipboard: serverless/serverless-base-data-stack-hash (`index`) _Updating serverless/.base/data-stack-hash.js using overwrite._ - Manage data stack hash resolver file.

Targets	Requires
`project` `└─ serverless` `└─ .base` `└─ data-stack-hash.js`	serverless aws

### :clipboard: serverless/serverless-base-data (`index`) _Updating serverless/.base/data.yml using overwrite._ - Manage serverless data stack base configuration file.

Targets	Requires
`project` `└─ serverless` `└─ .base` `└─ data.yml`	serverless aws

### :clipboard: serverless/serverless-base-api (`index`) _Updating serverless/.base/api.yml using overwrite._ - Manage serverless api stack base configuration file.

Targets	Requires	Variables
`project` `└─ serverless` `└─ .base` `└─ api.yml`	serverless aws	nccEnabled

### :clipboard: serverless/serverless-api-random-deploy-hash (`index`) _Updating serverless/api/random-deploy-hash.js using overwrite._ - Random hash to ensure lambda custom resource is redeployed.

Targets	Requires
`project` `└─ serverless` `└─ api` `└─ random-deploy-hash.js`	javascript aws serverless

### :clipboard: serverless/serverless-api (`index`) _Updating serverless/api.yml using create-only._ - Initialize api stack resource definition file.

Targets	Requires
`project` `└─ serverless` `└─ api.yml`	serverless aws

## :open_file_folder: package/#serverless (`index`) Manage package.json for serverless project.

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

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

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

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

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

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

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

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

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

## :open_file_folder: license/#closedsource (`index`) Manage license configuration for closed source project.

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

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

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

### :clipboard: license/UNLICENSED-file (`index`) _Updating LICENSE using overwrite._ - Generate UNLICENSED 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/#serverless (`index`) Manage gitignore configuration for serverless project.

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

### :clipboard: gitignore/serverless (`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 - Default ignores for Serverless Framework

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

## :open_file_folder: gally/#serverless (`index`) Manage gally configuration for serverless project.

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

### :clipboard: gally/serverless (`index`) _Updating .gally.json using overwrite._ - Restrictive serverless four-environment 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: docker/#serverless (`index`) Manage docker test configuration for serverless project.

Targets	Requires
`project` `├─ manage.sh` `└─ docker` `└─ Dockerfile`	docker serverless

### :clipboard: docker/sls-manage (`index`) _Updating manage.sh using overwrite._ - Spawn docker container for serverless testing and deploying.

Targets	Requires
`project` `└─ manage.sh`	docker serverless

### :clipboard: docker/sls-docker (`index`) _Updating docker/Dockerfile using overwrite._ - Docker environment definition for running tests in AWS Lambda container.

Targets	Requires
`project` `└─ docker` `└─ Dockerfile`	docker serverless

## :open_file_folder: circleci/#serverless (`index`) Manage circleci configuration for serverless project.

Targets	Requires	Variables
`project` `└─ .circleci` `└─ config.yml`	npm yarn gally github circleci dependabot semantic-release aws serverless	awsRegion projectName

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

Targets	Requires	Variables
`project` `└─ .circleci` `└─ config.yml`	npm yarn gally github circleci dependabot semantic-release aws serverless	awsRegion projectName

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

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

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

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

## :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/#serverless (`index`) Add badged for serverless project.

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

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

Targets	Requires	Variables
`project` `└─ README.md`	circleci	circleCiReadToken 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. ### 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. ### 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. ### 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. ### 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. ### serverless ([`link`](https://serverless.com/)) *Serverless Framework.* The Serverless Framework is a free and open-source web framework that was developed for building serverless applications. ### aws ([`link`](https://aws.amazon.com/)) *Amazon Web Services.* Amazon Web Services (AWS) is a subsidiary of Amazon that provides on-demand cloud computing platforms to individuals, companies and governments, on a metered pay-as-you-go basis. ### 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. ### 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. ### docker ([`link`](https://www.docker.com/)) *Container Platform.* Docker is a computer program that performs operating-system-level virtualization. Makes it for example possible to easily create and tear down complex test setups. ### yarn ([`link`](https://yarnpkg.com/)) *Dependency management similar to npm.* Very similar functionality to npm cli. ### 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. ### 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 ------ ## Variables ### awsRegion : `string` *Aws data center region code gets deployed to.* List of available regions can be found [here](https://docs.aws.amazon.com/general/latest/gr/rande.html). ### nccExclude : `array` **Default**: `` *Exclude packages from ncc compilation.* ### namespace : `string` *Namespace for this project.* A namespace is used to groups projects. Projects with the same namespace will use the same deployment bucket. Typically set to something like 'com.sls.ORGNAME' ### slsEndpointType : `string` *Endpoint Type for serverless provider.* ### projectName : `string` *Name of the project.* The project name is in most cases identical to the repository name. ### 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. ### 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.* ### circleCiReadToken : `string` **Default**: `null` *CircleCi Read Api Token.* CircleCi read only api token used to access build status. ------ ## Targets ### 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.* ### .mocharc.yml ([`link`](https://mochajs.org/#mochaopts)) :small_red_triangle: mocha, javascript :small_blue_diamond: `list` *Mocha test configuration file.* ### .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.* ### .github/ISSUE_TEMPLATE/feature_request.md :small_red_triangle: github, serverless :small_blue_diamond: `yml` *Github Feature Request Template* Template for Github Feature Request ### .github/ISSUE_TEMPLATE/bug_report.md :small_red_triangle: github, serverless :small_blue_diamond: `yml` *Github Bug Report Template* Template for Github Bug Report ### 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/7-sls-tags.spec.js :small_red_triangle: serverless :small_blue_diamond: `other` *Test to enforce resource tagging.* ### test/sls-cf-stack-routes.yml :small_red_triangle: serverless :small_blue_diamond: `yml` *Documented routes for testing* ### test/0-sls-cf-stack.spec.js :small_red_triangle: serverless :small_blue_diamond: `other` *Test for visualizing serverless cf stack definitions.* ### test/lib-test.sh :small_blue_diamond: `other` *Script for doing integration test against lib folder.* ### test/4-deps.spec.js :small_blue_diamond: `other` *Test to enforce dependency consistency.* ### src/core/aws.js :small_red_triangle: aws-sdk-wrap, aws :small_blue_diamond: `other` *Configuration file for aws-sdk initiation.* AWS SDK initialization file. ### serverless/pkg.js :small_red_triangle: serverless, javascript :small_blue_diamond: `other` *Serverless deploy package.json compiler.* Compiles deploy package.json file. ### serverless/data.yml :small_red_triangle: serverless, javascript :small_blue_diamond: `yml` *Data stack resource definition.* Contains user defined data stack resource definitions. ### serverless/compile.js :small_red_triangle: serverless, javascript :small_blue_diamond: `other` *Serverless config compiler.* Compiles serverless stack definition into output file. ### serverless/.base/resolver.js :small_red_triangle: serverless, javascript :small_blue_diamond: `yml` *Stack resolver js configuration.* Resolve serverless js configuration to requested stack. ### serverless/.base/resolver.yml :small_red_triangle: serverless, javascript :small_blue_diamond: `yml` *Stack resolver configuration.* Resolve serverless configuration to requested stack. ### serverless/.base/data-stack-hash.js :small_red_triangle: serverless, javascript :small_blue_diamond: `other` *Data Stack hash resolver.* Compute hash for data stack. ### serverless/.base/data.yml :small_red_triangle: serverless, javascript :small_blue_diamond: `yml` *Data Stack base configuration.* Defines data stack base configuration. ### serverless/.base/api.yml :small_red_triangle: serverless, javascript :small_blue_diamond: `yml` *Api Stack base configuration.* Defines api stack base configuration. ### serverless/api/random-deploy-hash.js :small_red_triangle: javascript, aws, serverless :small_blue_diamond: `other` *Api Stack Script Variable* Random hash to ensure lambda custom resource is redeployed. ### serverless/api.yml :small_red_triangle: serverless, javascript :small_blue_diamond: `yml` *Api stack resource definition.* Contains user defined api stack resource definitions. ### package.json ([`link`](https://docs.npmjs.com/files/package.json)) :small_red_triangle: npm :small_blue_diamond: `json` *Configuration for npm package.* ### 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. ### manage.sh :small_red_triangle: docker :small_blue_diamond: `other` *Prepare project to run tests.* File starts docker container(s) with necessary setup to execute the project tests. ### docker/Dockerfile ([`link`](https://docs.docker.com/engine/reference/builder/)) :small_red_triangle: docker :small_blue_diamond: `other` *Main docker container configuration file.* Contains instructions for the main docker container this repository uses for testing. ### .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.* ### 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. ------ ## 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. ### 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. ### 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. ### merge-below-title :small_blue_diamond: `list`, `nostruct` *Merges content below title.*