Skip to content

Commit

Permalink
Add baseUrl documentation (#6847)
Browse files Browse the repository at this point in the history
* Add baseUrl documentation

* Update docusaurus/docs/importing-a-component.md

Co-Authored-By: ianschmitz <ianschmitz@gmail.com>

* Update docusaurus/docs/importing-a-component.md

Co-Authored-By: ianschmitz <ianschmitz@gmail.com>

* Simplify include to match default tsconfig.json
  • Loading branch information
ianschmitz committed Apr 19, 2019
1 parent 200b98b commit 2303b49
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docusaurus/docs/importing-a-component.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,28 @@ Learn more about ES6 modules:
- [When to use the curly braces?](https://stackoverflow.com/questions/36795819/react-native-es-6-when-should-i-use-curly-braces-for-import/36796281#36796281)
- [Exploring ES6: Modules](http://exploringjs.com/es6/ch_modules.html)
- [Understanding ES6: Modules](https://leanpub.com/understandinges6/read#leanpub-auto-encapsulating-code-with-modules)

## Absolute Imports

You can configure your application to support importing modules using absolute paths. This can be done by configuring a `jsconfig.json` or `tsconfig.json` file in the root of your project. If you're using TypeScript in your project, you will already have a `tsconfig.json` file.

Below is an example `jsconfig.json` file for a JavaScript project. You can create the file if it doesn't already exist:

```json
{
"compilerOptions": {
"baseUrl": "src"
},
"include": ["src"]
}
```

If you're using TypeScript, you can configure the `baseUrl` setting inside the `compilerOptions` of your project's `tsconfig.json` file.

Now that you've configured your project to support absolute imports, if you want to import a module located at `src/components/Button.js`, you can import the module like so:

```js
import Button from 'components/Button';
```

For more information on these configuration files, see the [jsconfig.json reference](https://code.visualstudio.com/docs/languages/jsconfig) and [tsconfig.json reference](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html) documentation.

0 comments on commit 2303b49

Please sign in to comment.