Skip to content

Commit

Permalink
chore: initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
kyldvs committed Jun 2, 2024
0 parents commit 249769f
Show file tree
Hide file tree
Showing 20 changed files with 2,314 additions and 0 deletions.
15 changes: 15 additions & 0 deletions .github/actions/just/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
name: Set up just
description: Set up just

inputs:
github-token:
required: true
description: "pass secrets.GITHUB_TOKEN"

runs:
using: composite
steps:
- name: Install just
uses: extractions/setup-just@v1
env:
GITHUB_TOKEN: ${{ inputs.github-token }}
13 changes: 13 additions & 0 deletions .github/actions/node/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Set up node
description: Set up node

runs:
using: composite
steps:
- name: Setup pnpm
uses: pnpm/[email protected]

- name: Setup node
uses: actions/setup-node@v3
with:
node-version-file: ".nvmrc"
58 changes: 58 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: CI

on:
push:
branches: [main]
pull_request:
branches: [main]

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup node
uses: ./.github/actions/node

- name: Setup just
uses: ./.github/actions/just
with:
github-token: ${{ secrets.GITHUB_TOKEN }}

- name: Install
run: just ci install

- name: Build
run: just build

- name: Test
run: just test

- name: Check for uncommitted changes
run: git diff --exit-code

format:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup node
uses: ./.github/actions/node

- name: Setup just
uses: ./.github/actions/just
with:
github-token: ${{ secrets.GITHUB_TOKEN }}

- name: Install
run: just ci install

- name: Format
run: just ci format
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# misc
.DS_Store
*.pem

# env files
.env*
!.env.example

# dependencies
node_modules
.pnp
.pnp.js

# debug
npm-debug.log*

# use pnpm, not npm
.package-lock.json

# vscode settings
.vscode
4 changes: 4 additions & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

pnpm -- commitlint --edit ${1}
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

pnpm lint-staged
3 changes: 3 additions & 0 deletions .lintstagedrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
"*.{js,jsx,ts,tsx,json,yml,yaml,md,mdx}": "prettier --write",
};
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
pnpm-lock.yaml
10 changes: 10 additions & 0 deletions .prettierrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/** @type {import('prettier').Config} */
module.exports = {
endOfLine: "lf",
semi: true,
singleQuote: false,
tabWidth: 2,
trailingComma: "all",
printWidth: 80,
bracketSameLine: true,
};
120 changes: 120 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the
[Contributor Covenant](https://www.contributor-covenant.org/),
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Contributing

# Overview

- Install toolchains on your computer:
- [`just`](https://github.com/casey/just#installation) (command runner)
- [`pnpm`](https://pnpm.io/installation) (javascript)

## Setup

Run `just` to see available tasks.

## Commit style

Commits should follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/). Quick summary:

- All lowercase
- Message format: `<type>: <description>`
- Where type is like: `chore`, `feat`, `docs`, `ci`, `style`, etc.
- And description is a description of what the commit does.

# Code of Conduct

Contributions, including communications over issues, must follow our code of conduct. See: [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md).
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Kyle Davis

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# `dotfiles`

[![ci badge](https://github.com/kyldvs/dotfiles/actions/workflows/ci.yml/badge.svg)](https://github.com/kyldvs/dotfiles/actions)
[![license badge](https://img.shields.io/badge/license-MIT-blue)](./LICENSE)

My dotfiles!

# Contributing

Contributions are welcome, for more info see: [`CONTRIBUTING.md`](./CONTRIBUTING.md).

# License

[MIT](./LICENSE)
1 change: 1 addition & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = { extends: ["@commitlint/config-conventional"] };
47 changes: 47 additions & 0 deletions justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Read up on just here: https://github.com/casey/just

set fallback := true
set shell := ["bash", "-uc"]
set windows-shell := ["sh", "-uc"]

_default:
@just --list

# Print help.
help:
@just --list

# =============================================================================
# Simulate sub-commands by invoking with the directory and justfile set.
# =============================================================================

# See: https://github.com/casey/just/issues/208#issuecomment-453529888

# Common chores that need to be done.
chore +args="help":
@just -d `pwd` -f "tasks/chore/justfile" {{ args }}

# Tasks particular to a CI environment.
ci +args="help":
@just -d `pwd` -f "tasks/ci/justfile" {{ args }}

# =============================================================================
# Repo management.
# =============================================================================

# Run this first.
[group("repo")]
install:
pnpm install

[group("repo")]
build:
echo "There is no build command"

[group("repo")]
test:
echo "There is no test command"

[group("repo")]
format:
pnpm exec prettier --write "**/*.{js,jsx,ts,tsx,json,yml,yaml,md,mdx}"
16 changes: 16 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"name": "@kyldvs/dotfiles",
"version": "0.0.0",
"packageManager": "[email protected]",
"scripts": {
"help": "echo 'Scripts are in justfiles, run `just` for a list of tasks.'",
"prepare": "husky install"
},
"devDependencies": {
"@commitlint/cli": "^17.6.7",
"@commitlint/config-conventional": "^17.6.7",
"husky": "^8.0.0",
"lint-staged": "^13.2.3",
"prettier": "^3.0.0"
}
}
Loading

0 comments on commit 249769f

Please sign in to comment.