rsnext/examples/with-absolute-imports
Steven 4466ba436b
chore(examples): use default prettier for examples/templates (#60530)
## Description
This PR ensures that the default prettier config is used for examples
and templates.

This config is compatible with `prettier@3` as well (upgrading prettier
is bigger change that can be a future PR).

## Changes
- Updated `.prettierrc.json` in root with `"trailingComma": "es5"` (will
be needed upgrading to prettier@3)
- Added `examples/.prettierrc.json` with default config (this will
change every example)
- Added `packages/create-next-app/templates/.prettierrc.json` with
default config (this will change every template)

## Related

- Fixes #54402
- Closes #54409
2024-01-11 16:01:44 -07:00
..
components chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
pages chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
.gitignore Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
next-env.d.ts Remove incorrect entries for pnpm debug log (#47241) 2023-03-26 22:26:05 -07:00
package.json Convert with-absolute-imports example to TypeScript (#42529) 2022-11-07 14:19:42 -08:00
README.md chore(examples): use default prettier for examples/templates (#60530) 2024-01-11 16:01:44 -07:00
tsconfig.json Convert with-absolute-imports example to TypeScript (#42529) 2022-11-07 14:19:42 -08:00

Absolute Imports and Aliases

This example shows how to configure Absolute imports and Module path aliases in tsconfig.json (or jsconfig.json for JavaScript projects). These options will allow absolute imports from . (the root directory), and allow you to create custom import aliases.

If youre working on a large project, your relative import statements might suffer from ../../../ spaghetti:

import Button from "../../../components/button";

In such cases, we might want to setup absolute imports using the baseUrl option, for clearer and shorter imports:

import Button from "components/button";

Furthermore, TypeScript also supports the paths option, which allows you to configure custom module aliases. You can then use your alias like so:

import Button from "@/components/button";

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-absolute-imports with-absolute-imports-app
yarn create next-app --example with-absolute-imports with-absolute-imports-app
pnpm create next-app --example with-absolute-imports with-absolute-imports-app

Deploy it to the cloud with Vercel (Documentation).