diff --git a/.github/codespellrc b/.github/codespellrc index 61cf98da7..73a213e1f 100644 --- a/.github/codespellrc +++ b/.github/codespellrc @@ -1,3 +1,3 @@ [codespell] -skip = ./**/*.svg,./elixir/deps,./**/*.min.js,./kotlin/android/app/build,./e2e/pnpm-lock.yaml,./website/.next,./website/pnpm-lock.yaml,./rust/target,Cargo.lock,./website/docs/reference/api/*.mdx,./**/erl_crash.dump,./cover,./vendor,*.json,seeds.exs,./**/node_modules,./deps,./priv/static,./priv/plts,./**/priv/static,./.git,./_build +skip = ./**/*.svg,./elixir/deps,./**/*.min.js,./kotlin/android/app/build,./kotlin/android/build,./e2e/pnpm-lock.yaml,./website/.next,./website/pnpm-lock.yaml,./rust/target,Cargo.lock,./website/docs/reference/api/*.mdx,./**/erl_crash.dump,./cover,./vendor,*.json,seeds.exs,./**/node_modules,./deps,./priv/static,./priv/plts,./**/priv/static,./.git,./_build ignore-words-list = optin,crate,keypair,keypairs,iif,statics,wee,anull,commitish,inout,fo,superceded diff --git a/.github/pre-commit-config.yaml b/.github/pre-commit-config.yaml index b57224485..5d43d380b 100644 --- a/.github/pre-commit-config.yaml +++ b/.github/pre-commit-config.yaml @@ -10,7 +10,7 @@ repos: # Standard pre-commit hooks - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + rev: v4.6.0 hooks: - id: mixed-line-ending args: ["--fix=lf"] @@ -32,15 +32,32 @@ repos: # Third party pre-commit hooks - repo: https://github.com/koalaman/shellcheck-precommit - rev: v0.9.0 + rev: v0.10.0 hooks: - id: shellcheck args: ["--severity=warning"] exclude: ^.*/gradlew$ - repo: https://github.com/pecigonzalo/pre-commit-shfmt - rev: v2.1.0 + rev: v2.2.0 hooks: - id: shell-fmt args: - -i - "4" + - repo: https://github.com/pre-commit/mirrors-prettier + rev: "v4.0.0-alpha.8" + hooks: + - id: prettier + # Exclude non-website files for now + # TODO: Lint these files in all directories + exclude: "^(?!website/)" + types_or: + - javascript + - jsx + - css + - scss + - json + - mdx + - markdown + - html + - xml diff --git a/website/README.md b/website/README.md index 7b08188b4..a5176b603 100644 --- a/website/README.md +++ b/website/README.md @@ -19,9 +19,11 @@ result. You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. -This project uses -[`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to -automatically optimize and load Inter, a custom Google Font. +### Linting + +This project uses [Prettier](https://prettier.io/) to format code and ensure a +consistent style. Use the [.prettierrc.json](../.prettierrc.json) in the root of +this repo to configure your editor. ## Learn More diff --git a/website/src/app/docs/authenticate/oidc/auth0/readme.mdx b/website/src/app/docs/authenticate/oidc/auth0/readme.mdx index 8be91d9be..88d88e35d 100644 --- a/website/src/app/docs/authenticate/oidc/auth0/readme.mdx +++ b/website/src/app/docs/authenticate/oidc/auth0/readme.mdx @@ -27,7 +27,8 @@ settings required for the integration: In the Auth0 dashboard, create an application. Select **Regular Web Application** as the application type. -auth0 configuration/callback/` (e.g. `https://firezone.example.com/auth/oidc/auth0/callback/`). -auth0 settings 1 -auth0 settings 2 -auth0 settings 3 Applications** and click **Create App Integration**. Set **Sign-in method** to **OICD - OpenID Connect** and **Application type** to **Web application**. -okta create options Custom Connectors**. ` + /auth/oidc//callback/` (e.g. `https://firezone.example.com/auth/oidc/onelogin/callback/`). -onelogin configuration Primary email | -google saml -In this guide, we'll use Firezone to secure access to a host based on the -host's private IP address. +In this guide, we'll use Firezone to secure access to a host based on the host's +private IP address. This is useful when you have a host that may be behind a firewall that you want to keep secure, but still need to access it from external networks like the diff --git a/website/src/app/kb/use-cases/nat-gateway/readme.mdx b/website/src/app/kb/use-cases/nat-gateway/readme.mdx index b28029cab..fadbce854 100644 --- a/website/src/app/kb/use-cases/nat-gateway/readme.mdx +++ b/website/src/app/kb/use-cases/nat-gateway/readme.mdx @@ -14,9 +14,9 @@ In this guide, we'll walk through the configuration required to use Firezone to route traffic through a public IP address, sometimes known as a NAT Gateway configuration. -Use this when you need your team's traffic to appear to come from a -single, static IP address to use services that require source traffic to come -from specified IP allowlists. +Use this when you need your team's traffic to appear to come from a single, +static IP address to use services that require source traffic to come from +specified IP allowlists. After completing this guide, your team's traffic will be routed to a Firezone Gateway and then out to the internet using its public IP address. diff --git a/website/src/app/kb/use-cases/private-network-access/readme.mdx b/website/src/app/kb/use-cases/private-network-access/readme.mdx index e72652967..2493828d3 100644 --- a/website/src/app/kb/use-cases/private-network-access/readme.mdx +++ b/website/src/app/kb/use-cases/private-network-access/readme.mdx @@ -21,8 +21,9 @@ internet. In general, we recommend using a more granular approach to secure access using either [DNS](/kb/use-cases/web-app-access) or [IP-based](/kb/use-cases/host-access) Resources instead of the blanket - approach used in this guide. Only use this guide if using DNS - or IP-based Resources is not feasible, or if you need a stepping stone towards a more granular approach. + approach used in this guide. Only use this guide if using DNS or IP-based + Resources is not feasible, or if you need a stepping stone towards a more + granular approach. ## Prerequisites