Skip to content

Commit

Permalink
Merge branch 'main' into fix/update-summary
Browse files Browse the repository at this point in the history
  • Loading branch information
AmadiMichael authored Aug 13, 2024
2 parents 8b6fb85 + 554fa9d commit eec88f4
Show file tree
Hide file tree
Showing 28 changed files with 3,318 additions and 1,103 deletions.
3 changes: 3 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ jobs:
- image: <<pipeline.parameters.ci_builder_image>>
steps:
- checkout
- run:
name: Install pnpm
command: npm install -g [email protected]
- run:
name: Install deps
command: just deps
Expand Down
10 changes: 9 additions & 1 deletion Justfile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ deps:
pnpm i --frozen-lockfile

# Lint the workspace for all available targets
lint: lint-specs-md-check lint-specs-toc-check lint-filenames lint-links
lint: lint-specs-md-check lint-specs-toc-check lint-filenames lint-links lint-specs-spelling

# Updates all files to fix linting issues
lint-fix: lint-specs-md-fix lint-specs-toc
Expand All @@ -37,6 +37,14 @@ lint-links:
--exclude twitter.com --exclude explorer.optimism.io --exclude linux-mips.org --exclude vitalik.eth.limo \
--exclude-mail /input/README.md "/input/specs/**/*.md"

# Validates spelling using cspell
lint-specs-spelling:
npx cspell "./**/*.md"

# Updates cspell words file with new words
lint-specs-spelling-fix:
npx cspell --words-only --unique "./**/*.md" | sort --ignore-case | uniq > words.txt

lint-filenames:
#!/usr/bin/env bash
for file in $(find ./specs -type f); do
Expand Down
24 changes: 24 additions & 0 deletions cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-types/cspell.schema.json",
"version": "0.2",
"dictionaryDefinitions": [
{
"name": "words",
"path": "./words.txt",
"addWords": true
}
],
"dictionaries": [
"words"
],
"ignorePaths": [
"node_modules",
"./words.txt"
],
"overrides": [
{
"filename": "**/*.md",
"ignoreRegExpList": []
}
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The threshold for which changes require a governance vote is based on the User P
- Hardfork is prepared *[If needed - hardforks are needed if we are adding major/protocol-level changes to our stack]*
- Named hardfork is created
- Code has been configured to activate with the named hardfork
- Ugrades of Fault Proof systems are prepared
- Upgrades of Fault Proof systems are prepared

## 4. Security standards and criteria check are done

Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
"private": true,
"engines": {
"node": ">=16",
"pnpm": ">=8"
"pnpm": ">=9"
},
"dependencies": {
"doctoc": "^2.2.1",
"markdownlint-cli2": "0.4.0"
"markdownlint-cli2": "0.4.0",
"cspell": "^8.1.3"
}
}
Loading

0 comments on commit eec88f4

Please sign in to comment.