Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ indent_size = 4

# JavaScript/TypeScript files
[*.{js,jsx,ts,tsx}]
indent_size = 4
indent_size = 2

# JSON files
[*.{json,jsonc}]
Expand Down
15 changes: 14 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: dev build format lint test install clean lint_md lint_md_fix mint-broken-links mint-broken-links-all format-check
.PHONY: dev build format lint test install clean lint_md lint_md_fix mint-broken-links mint-broken-links-all build-references preview-references format-check

dev:
@echo "Starting development mode..."
Expand Down Expand Up @@ -74,12 +74,25 @@ mint-broken-links-all: build
@command -v mint >/dev/null 2>&1 || { echo "Error: mint is not installed. Run 'npm install -g [email protected]'"; exit 1; }
@cd build && mint broken-links 2>&1 | python3 ../scripts/filter_broken_links.py

check-pnpm:
@command -v pnpm >/dev/null 2>&1 || { echo >&2 "pnpm is not installed. Please install pnpm to proceed (https://pnpm.io/installation)"; exit 1; }

build-references: check-pnpm
@echo "Building references..."
cd reference && pnpm i && pnpm build

preview-references: check-pnpm
@echo "Previewing references..."
cd reference && pnpm i && pnpm run preview

help:
@echo "Available commands:"
@echo " make dev - Start development mode with file watching and mint dev"
@echo " make build - Build documentation to ./build directory"
@echo " make mint-broken-links - Check for broken links in built documentation (excludes integrations)"
@echo " make mint-broken-links-all - Check for broken links in built documentation (includes all directories)"
@echo " make build-references - Build reference docs"
@echo " make preview-references - Preview reference docs"
@echo " make format - Format code"
@echo " make lint - Lint code"
@echo " make lint_md - Lint markdown files"
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Documentation changes follow a PR workflow where all tests must pass before merg
```text
src/ # Source documentation files (edit these)
build/ # Generated output files (do not edit)
reference/ # Reference docs pipeline
pipeline/ # Build pipeline source code
tests/ # Test files for the pipeline
Makefile # Build automation
Expand Down Expand Up @@ -75,6 +76,8 @@ Makefile # Build automation
- `make build` - Build documentation to `./build` directory
- `make mint-broken-links` - Check for broken links in built documentation (excludes integrations)
- `make mint-broken-links-all` - Check for broken links in built documentation (includes all directories)
- `make build-references` - Build reference docs
- `make preview-references` - Preview reference docs
- `make install` - Install all dependencies
- `make clean` - Remove build artifacts
- `make test` - Run the test suite
Expand Down
1 change: 1 addition & 0 deletions reference/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.vercel
5 changes: 5 additions & 0 deletions reference/javascript/.eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
node_modules
public
remotes
dist

18 changes: 18 additions & 0 deletions reference/javascript/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
module.exports = {
root: true,
env: {
node: true,
es2022: true,
},
parser: '@typescript-eslint/parser',
parserOptions: {
ecmaVersion: 'latest',
sourceType: 'module',
},
plugins: ['@typescript-eslint'],
extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
rules: {
'@typescript-eslint/no-explicit-any': 'off',
},
ignorePatterns: ['node_modules/', 'public/', 'remotes/', 'dist/'],
};
11 changes: 11 additions & 0 deletions reference/javascript/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
*
node_modules
!.gitignore
!.prettierrc
!.prettierignore
!eslint.config.mjs
!build.ts
!Makefile
!package.json
!pnpm-lock.yaml
!tsconfig.json
6 changes: 6 additions & 0 deletions reference/javascript/.prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
node_modules
public
remotes
dist
pnpm-lock.yaml

9 changes: 9 additions & 0 deletions reference/javascript/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "es5",
"printWidth": 100,
"bracketSpacing": true,
"arrowParens": "always"
}
Loading