mirror of
https://github.com/outline/outline.git
synced 2026-08-03 13:27:25 +03:00
chore: Remove straggling mentions of prettier (#12907)
This commit is contained in:
@@ -9,7 +9,7 @@ There is a web client which is fully responsive and works on mobile devices.
|
|||||||
- **`shared/`** - Shared TypeScript types, utilities, and editor components
|
- **`shared/`** - Shared TypeScript types, utilities, and editor components
|
||||||
- **`plugins/`** - Plugin system for extending functionality
|
- **`plugins/`** - Plugin system for extending functionality
|
||||||
- **`public/`** - Static assets served directly
|
- **`public/`** - Static assets served directly
|
||||||
- **Various config files** - TypeScript, Vite, Vitest, Prettier, Oxlint configurations
|
- **Various config files** - TypeScript, Vite, Vitest, oxfmt, Oxlint configurations
|
||||||
|
|
||||||
Refer to /docs/ARCHITECTURE.md for detailed architecture documentation.
|
Refer to /docs/ARCHITECTURE.md for detailed architecture documentation.
|
||||||
|
|
||||||
@@ -33,7 +33,7 @@ You're an expert in the following areas:
|
|||||||
- Critical – Do not create new markdown (.md) files.
|
- Critical – Do not create new markdown (.md) files.
|
||||||
- Use early returns for readability.
|
- Use early returns for readability.
|
||||||
- Emphasize type safety and static analysis.
|
- Emphasize type safety and static analysis.
|
||||||
- Follow consistent Prettier formatting.
|
- Follow consistent oxfmt formatting.
|
||||||
- Do not replace smart quotes ("") or ('') with simple quotes ("").
|
- Do not replace smart quotes ("") or ('') with simple quotes ("").
|
||||||
- Do not add translation strings manually; they will be extracted automatically from the codebase.
|
- Do not add translation strings manually; they will be extracted automatically from the codebase.
|
||||||
|
|
||||||
@@ -175,7 +175,7 @@ yarn test:shared # All shared code tests
|
|||||||
## Code Quality
|
## Code Quality
|
||||||
|
|
||||||
- Use Oxlint for linting: `yarn lint`
|
- Use Oxlint for linting: `yarn lint`
|
||||||
- Format code with Prettier: `yarn format`
|
- Format code with oxfmt: `yarn format`
|
||||||
- Check types with TypeScript: `yarn tsc`
|
- Check types with TypeScript: `yarn tsc`
|
||||||
- Pre-commit hooks run automatically via Husky.
|
- Pre-commit hooks run automatically via Husky.
|
||||||
- Fix linting issues before committing.
|
- Fix linting issues before committing.
|
||||||
|
|||||||
@@ -12,7 +12,6 @@
|
|||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="http://www.typescriptlang.org" rel="nofollow"><img src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg" alt="TypeScript"></a>
|
<a href="http://www.typescriptlang.org" rel="nofollow"><img src="https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg" alt="TypeScript"></a>
|
||||||
<a href="https://github.com/prettier/prettier"><img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat" alt="Prettier"></a>
|
|
||||||
<a href="https://github.com/styled-components/styled-components"><img src="https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg" alt="Styled Components"></a>
|
<a href="https://github.com/styled-components/styled-components"><img src="https://img.shields.io/badge/style-%F0%9F%92%85%20styled--components-orange.svg" alt="Styled Components"></a>
|
||||||
<a href="https://translate.getoutline.com/project/outline" alt="Localized"><img src="https://badges.crowdin.net/outline/localized.svg"></a>
|
<a href="https://translate.getoutline.com/project/outline" alt="Localized"><img src="https://badges.crowdin.net/outline/localized.svg"></a>
|
||||||
</p>
|
</p>
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
# Architecture
|
# Architecture
|
||||||
|
|
||||||
Outline is composed of a backend and frontend codebase in this monorepo. As both are written in TypeScript, they share some code where possible. We utilize the latest ES6 language features, including `async`/`await`, and types. Prettier formatting and Oxlint are enforced by CI.
|
Outline is composed of a backend and frontend codebase in this monorepo. As both are written in TypeScript, they share some code where possible. We utilize the latest ES6 language features, including `async`/`await`, and types. oxfmt formatting and Oxlint are enforced by CI.
|
||||||
|
|
||||||
## Frontend
|
## Frontend
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user