archive/rsnext
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
rsnext/examples/with-absolute-imports/README.md
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

2.1 KiB
Raw Blame History

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 you’re 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).