Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ShahradR/git-template

Language-agnostic Git template repository to kickstart your projects!
https://github.com/ShahradR/git-template

template vscode

Last synced: about 1 month ago
JSON representation

Language-agnostic Git template repository to kickstart your projects!

Host: GitHub
URL: https://github.com/ShahradR/git-template
Owner: ShahradR
License: mit-0
Created: 2020-01-31T23:35:17.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-02-09T01:55:13.000Z (8 months ago)
Last Synced: 2024-06-16T15:42:08.827Z (3 months ago)
Topics: template, vscode
Language: Dockerfile
Homepage:
Size: 11.6 MB
Stars: 5
Watchers: 3
Forks: 1
Open Issues: 7
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

# git-template

![GitHub workflow](https://img.shields.io/github/workflow/status/ShahradR/git-template/CI%20workflow?logo=github)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![License: MIT-0](https://img.shields.io/badge/license-MIT--0-yellowgreen)](https://spdx.org/licenses/MIT-0.html)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

Language-agnostic Git template repository to kickstart your projects!

## How to use this template

### Create a new repository from the template

To use this template for your new project, click **"Use this template"** near
the top of the page, and select a name for your repository to create it in your
own account or organization.

![Creating a repository from this template](./doc-files/images/github-create-repo-from-template.gif)

### Clone your new repository locally

Once your new repository has been created, clone the repository to your local
computer using the `git clone` command.

```shell
git clone https://github.com//
```

### Configure pre-commit

This template is configured to run Git hooks using
[pre-commit](https://pre-commit.com/), a "framework for managing and maintaining
multi-language pre-commit hooks." Linters and common checks are ran against your
commits, catching errors and making sure your code is up to snuff before sharing
it with the world!

After pre-commit is installed (consider using a
[Python virtual environment](https://docs.python.org/3/library/venv.html)), run
the following command to configure the pre-commit hooks for your repository:

```shell
pre-commit install && pre-commit install --hook-type commit-msg
```

[The pre-commit hooks supplied with this project will cover most situations](https://github.com/ShahradR/git-template/pull/1),
but you might wish to add more to the list depending on your requirements. Below
are several examples of `.pre-commit-config.yaml` files used for different use
cases—use this to tailor your hooks based on your project's needs!

Java

This version of the configuration file adds Java support by:

- Augmenting Prettier with
[JHipster's Prettier plugin for Java](https://github.com/jhipster/prettier-java)
- Running [Checkstyle](https://checkstyle.sourceforge.io/) using the pre-commit
hook provided by
[gherynos/pre-commit-java](https://github.com/gherynos/pre-commit-java)
- Checkstyle can also run as a plugin for Ant, Maven, or Gradle. Depending on
your use case, you might want to run this check in your build automation
tool instead

#### Prettier

[![asciicast](https://asciinema.org/a/359757.svg)](https://asciinema.org/a/359757)

#### Checkstyle

[![asciicast](https://asciinema.org/a/359758.svg)](https://asciinema.org/a/359758)

```diff
---
default_stages: [commit]
exclude: vale/styles/*
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.3.0
hooks:
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
- id: check-case-conflict
- id: detect-private-key
- id: mixed-line-ending
args: [--fix=no]
- id: check-added-large-files
args: [--maxkb=10240]

- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
rev: v4.0.0
hooks:
- id: commitlint
stages: [commit-msg]
additional_dependencies: ["@commitlint/config-conventional"]

- repo: https://github.com/pre-commit/mirrors-prettier
rev: v2.2.1
hooks:
- id: prettier
name: Prettier
+ args:
+ - --plugin=prettier-plugin-java
+ additional_dependencies:
+ - [email protected]

- repo: local
hooks:
- id: dockerfile-provides-entrypoint
name: Vale
language: docker_image
entry: jdkato/vale:latest

+ - repo: https://github.com/gherynos/pre-commit-java
+ rev: v0.1.0
+ hooks:
+ - id: checkstyle
+ name: Checkstyle
```

JavaScript/TypeScript

This version of the file introduces
[pre-commit/mirrors-eslint](https://github.com/pre-commit/mirrors-eslint) to run
[ESLint](https://eslint.org/), a tool to "find and fix problems in your
JavaScript code."

You'll need a valid ESLint configuration file to run this hook—see
[Configuring ESLint](https://eslint.org/docs/user-guide/configuring) for details
on how to set up your environment.

[![asciicast](https://asciinema.org/a/359740.svg)](https://asciinema.org/a/359740)

The pre-commit configuration has been adapted to lint both JavaScript and
TypeScript code. The ESLint plugins required to run the hook must be listed
under `additional_dependencies`—this particular example was taken from the
[ShahradR/action-taskcat](https://github.com/ShahradR/action-taskcat) project,
but you might need to customize the dependency list to fit your needs.

- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
rev: v4.0.0
hooks:
- id: commitlint
stages: [commit-msg]
additional_dependencies: ["@commitlint/config-conventional"]

- repo: https://github.com/pre-commit/mirrors-prettier
rev: v2.2.1
hooks:
- id: prettier
name: Prettier

- repo: local
hooks:
- id: dockerfile-provides-entrypoint
name: Vale
language: docker_image
entry: jdkato/vale:latest

+ - repo: https://github.com/pre-commit/mirrors-eslint
+ rev: v7.9.0
+ hooks:
+ - id: eslint
+ name: ESLint
+ files: \.[jt]sx?$ # *.js, *.jsx, *.ts and *.tsx
+ types: [file]
+ additional_dependencies:
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - [email protected]
+ - "@typescript-eslint/[email protected]"
+ - "@typescript-eslint/[email protected]"
```

AWS CloudFormation templates

This version of the file adds the following pre-commit checks:

- [CloudFormation Linter](https://github.com/aws-cloudformation/cfn-python-lint)
to "validate CloudFormation yaml/json templates against the CloudFormation
Resource Specification"
- [Stelligent cfn_nag](https://github.com/stelligent/cfn_nag) to "look for
patterns in CloudFormation templates that may indicate insecure
infrastructure"

#### CloudFormation Linter

[![asciicast](https://asciinema.org/a/308273.svg)](https://asciinema.org/a/308273)

#### Stelligent cfn_nag

[![asciicast](https://asciinema.org/a/308270.svg)](https://asciinema.org/a/308270)

This configuration expects the templates to reside under the `templates/`
directory, at the root of the repository.

- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
rev: v4.0.0
hooks:
- id: commitlint
stages: [commit-msg]
additional_dependencies: ["@commitlint/config-conventional"]

- repo: https://github.com/pre-commit/mirrors-prettier
rev: v2.2.1
hooks:
- id: prettier
name: Prettier

- repo: local
hooks:
- id: dockerfile-provides-entrypoint
name: Vale
language: docker_image
entry: jdkato/vale:latest

+ - repo: https://github.com/aws-cloudformation/cfn-python-lint
+ rev: v0.35.1
+ hooks:
+ - id: cfn-python-lint
+ files: templates/.*\.(json|yml|yaml)$
+
+ - repo: local
+ hooks:
+ - id: dockerfile-provides-entrypoint
+ name: cfn_nag
+ language: docker_image
+ entry: stelligent/cfn_nag:latest
+ files: templates/.*\.(json|yml|yaml)$
+ args: ["--fail-on-warnings"]
```

Docker containers

This version of the file adds the
[Haskell Dockerfile Linter](https://github.com/hadolint/hadolint) "a smarter
Dockerfile linter that helps you build best practice Docker images" as a
pre-commit hook.

[![asciicast](https://asciinema.org/a/335409.svg)](https://asciinema.org/a/335409)

- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
rev: v4.0.0
hooks:
- id: commitlint
stages: [commit-msg]
additional_dependencies: ["@commitlint/config-conventional"]

- repo: https://github.com/pre-commit/mirrors-prettier
rev: v2.2.1
hooks:
- id: prettier
name: Prettier

- repo: local
hooks:
- id: dockerfile-provides-entrypoint
name: Vale
language: docker_image
entry: jdkato/vale:latest

+ - repo: local
+ hooks:
+ - id: dockerfile-provides-entrypoint
+ name: hadolint
+ language: docker_image
+ entry: --entrypoint hadolint hadolint/hadolint:latest-debian
+ files: Dockerfile
```

OpenAPI/Swagger specifications

This version of the file adds [speccy](https://github.com/wework/speccy) as a
pre-commit hook, to "enforce quality rules on your OpenAPI 3.0.x
specifications."

[![asciicast](https://asciinema.org/a/308584.svg)](https://asciinema.org/a/308584)

This configuration expects the OpenAPI specification file to reside under the
`specs/` directory, at the root of the repository.

- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
rev: v4.0.0
hooks:
- id: commitlint
stages: [commit-msg]
additional_dependencies: ["@commitlint/config-conventional"]

- repo: https://github.com/pre-commit/mirrors-prettier
rev: v2.2.1
hooks:
- id: prettier
name: Prettier

- repo: local
hooks:
- id: dockerfile-provides-entrypoint
name: Vale
language: docker_image
entry: jdkato/vale:latest

+ - repo: local
+ hooks:
+ - id: dockerfile-provides-entrypoint
+ name: Speccy
+ language: docker_image
+ entry: wework/speccy:latest lint
+ files: 'specs/.*\.(yml|json|yaml)$'
```

### Configure your continuous integration pipeline

TODO: Configuration steps for GitHub Actions will change once workflow templates
are implemented. See
[ShahradR/git-template#15](https://github.com/ShahradR/git-template/issues/15)
for more details.

### Update your LICENSE file

This repository is licensed under
[MIT No Attribution (MIT-0)](https://spdx.org/licenses/MIT-0.html)—you are free
to use this template for your project without the need to worry about
attribution.

Update the LICENSE file with a license appropriate for your project! Visit
to see common open-source licenses.

### Update the README file

Once everything has been set up, delete this file and replace it with a README
tailored to your project!

### Update the Code of Conduct contact information

Update the `[INSERT CONTACT METHOD]` string in the project's Code of Conduct to
include an e-mail address owned by a member of your community to help mediate
any disputes.