Skip to content
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
{
"version": "0.2",
"language": "en, en-gb, en-us",
"useGitignore": true,
"caseSensitive": false,
"import": [
"@cspell/dict-en_us/cspell-ext.json",
"@cspell/dict-en-gb/cspell-ext.json",
"@cspell/dict-software-terms/cspell-ext.json",
"@cspell/dict-golang/cspell-ext.json",
"@cspell/dict-fullstack/cspell-ext.json",
"@cspell/dict-docker/cspell-ext.json",
"@cspell/dict-k8s/cspell-ext.json",
"@cspell/dict-node/cspell-ext.json",
"@cspell/dict-npm/cspell-ext.json",
"@cspell/dict-typescript/cspell-ext.json",
"@cspell/dict-html/cspell-ext.json",
"@cspell/dict-css/cspell-ext.json",
"@cspell/dict-shell/cspell-ext.json",
"@cspell/dict-python/cspell-ext.json",
"@cspell/dict-redis/cspell-ext.json",
"@cspell/dict-sql/cspell-ext.json",
"@cspell/dict-filetypes/cspell-ext.json",
"@cspell/dict-companies/cspell-ext.json",
"@cspell/dict-markdown/cspell-ext.json",
"@cspell/dict-en-common-misspellings/cspell-ext.json",
"@cspell/dict-people-names/cspell-ext.json"
],
"dictionaries": [
"en_us",
"en-gb",
"softwareTerms",
"web-services",
"networking-terms",
"software-term-suggestions",
"software-services",
"software-terms",
"software-tools",
"coding-compound-terms",
"golang",
"fullstack",
"docker",
"k8s",
"node",
"npm",
"typescript",
"html",
"css",
"shell",
"python",
"redis",
"sql",
"filetypes",
"companies",
"markdown",
"en-common-misspellings",
"people-names",
"data-science",
"data-science-models",
"data-science-tools",
"project-words"
],
"dictionaryDefinitions": [
{
"name": "project-words",
"path": "./project-words.txt",
"addWords": true
}
],
"files": [
"blog/**",
"src/**"
],
"ignorePaths": [
"**/*.svg",
"**/*.png",
"**/*.jpg",
"**/*.jpeg",
"**/*.gif",
"**/*.ico",
"**/*.lock"
]
}
70 changes: 70 additions & 0 deletions .github/workflows/spell-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: Spell check

on:
workflow_dispatch:
pull_request:
types:
- opened
- synchronize
- reopened
- ready_for_review
push:
branches:
- main
- master

permissions:
contents: read
pull-requests: read

jobs:
cspell:
name: cspell
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

- name: Set up Node.js
uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
with:
node-version: "20.x"

- name: Install cspell dictionaries
run: |
npm install --no-save \
@cspell/dict-en_us \
@cspell/dict-en-gb \
@cspell/dict-software-terms \
@cspell/dict-golang \
@cspell/dict-fullstack \
@cspell/dict-docker \
@cspell/dict-k8s \
@cspell/dict-node \
@cspell/dict-npm \
@cspell/dict-typescript \
@cspell/dict-html \
@cspell/dict-css \
@cspell/dict-shell \
@cspell/dict-python \
@cspell/dict-redis \
@cspell/dict-sql \
@cspell/dict-filetypes \
@cspell/dict-companies \
@cspell/dict-markdown \
@cspell/dict-en-common-misspellings \
@cspell/dict-people-names \
@cspell/dict-data-science

- name: Run cspell
uses: streetsidesoftware/cspell-action@de2a73e963e7443969755b648a1008f77033c5b2 # v8.4.0
with:
incremental_files_only: false
check_dot_files: explicit
report: typos
verbose: true

- name: Run codespell
uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579 # v2.2
with:
path: blog src
ignore_words_list: TE,te
55 changes: 55 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
## help: 💡 Display available commands
.PHONY: help
help:
@echo '⚡️ GoFiber/Docs Development:'
@sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /'

## install: 📦 Install dependencies
.PHONY: install
install:
npm install

## dev: 🚀 Start development server
.PHONY: dev
dev:
npm start

## build: 🏗 Build production site
.PHONY: build
build:
npm run build

## serve: 🌐 Serve production build locally
.PHONY: serve
serve:
npm run serve

## spell: 📝 Run spell check on blog and website source
.PHONY: spell
spell:
npx cspell "blog/**" "src/**" --no-progress

## codespell: 📝 Run codespell on blog and website source
.PHONY: codespell
codespell:
codespell blog src --ignore-words-list "TE,te"

## markdown: 🎨 Find markdown format issues (Requires markdownlint-cli2)
.PHONY: markdown
markdown:
@which markdownlint-cli2 > /dev/null || npm install -g markdownlint-cli2
markdownlint-cli2 "blog/**/*.md"
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Outdated

## lint: 🚨 Run all lint checks (spell + markdown)
.PHONY: lint
lint: spell codespell markdown
Comment thread
ReneWerner87 marked this conversation as resolved.

## format: 🎨 Fix code format issues
.PHONY: format
format:
npx prettier --write "src/**/*.{ts,tsx,scss,css,json}" "blog/**/*.md"

## clean: 🧹 Clean build artifacts
.PHONY: clean
clean:
rm -rf build .docusaurus
Loading
Loading