rsnext/examples/with-absolute-imports
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00:00
..
components Convert with-absolute-imports example to TypeScript (#42529) 2022-11-07 14:19:42 -08:00
pages Convert with-absolute-imports example to TypeScript (#42529) 2022-11-07 14:19:42 -08: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 update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04: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).