├── .gitignore ├── .npmignore ├── LICENSE ├── README.md ├── gatsby-node.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (http://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # Typescript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | 5 | # Runtime data 6 | pids 7 | *.pid 8 | *.seed 9 | 10 | # Directory for instrumented libs generated by jscoverage/JSCover 11 | lib-cov 12 | 13 | # Coverage directory used by tools like istanbul 14 | coverage 15 | 16 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 17 | .grunt 18 | 19 | # node-waf configuration 20 | .lock-wscript 21 | 22 | # Compiled binary addons (http://nodejs.org/api/addons.html) 23 | build/Release 24 | 25 | # Dependency directory 26 | # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git 27 | node_modules 28 | *.un~ 29 | yarn.lock 30 | src 31 | flow-typed 32 | coverage 33 | decls 34 | examples 35 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2017 Aaron Lampros 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # gatsby-plugin-resolve-src 2 | Gatsby plugin to resolve imports from your project's `/src` directory 3 | 4 | This plugin modifies your webpack config to allow imports from your `/src` directory, such as: 5 | 6 | ```js 7 | import MyComponent from 'components/MyComponent' 8 | ``` 9 | 10 | ...instead of 11 | 12 | ```js 13 | import MyComponent from '../../components/MyComponent' 14 | ``` 15 | 16 | # Usage 17 | 18 | Add it to your project 19 | 20 | ```sh 21 | yarn add gatsby-plugin-resolve-src 22 | ``` 23 | 24 | Then add it to your `gatsby-config.js`: 25 | 26 | ```js 27 | { 28 | plugins: [ 29 | 'gatsby-plugin-resolve-src', 30 | ] 31 | } 32 | ``` 33 | 34 | ## VSCode Configuration 35 | 36 | You have to tell VS Code how to find your modules by creating a `tsconfig.json` (or `jsconfig.json`) file in your project root. For example: 37 | 38 | ```json 39 | { 40 | "compilerOptions": { 41 | "baseUrl": "./src", 42 | "paths": { 43 | "*": [ 44 | "types/*", 45 | "*" 46 | ] 47 | } 48 | }, 49 | } 50 | ``` 51 | 52 | See [#9](https://github.com/alampros/gatsby-plugin-resolve-src/issues/9) for more info. 53 | 54 | ## ESLint Configuration 55 | 56 | If using `eslint-plugin-import`, you have to tell ESLint how to find your modules by configuring the default `node` resolver in your eslint config. For example: 57 | 58 | ```json 59 | { 60 | "settings": { 61 | "import/resolver": { 62 | "node": { 63 | "moduleDirectory": ["node_modules", "src"] 64 | } 65 | } 66 | } 67 | } 68 | ``` 69 | 70 | If your project is linting filetypes besides `.js`, you will have to add them explicitly. See the node resolver [documentation](https://www.npmjs.com/package/eslint-import-resolver-node) for more details. 71 | 72 | ## Options 73 | 74 | ### `srcPath` (file path) 75 | 76 | Default: `path.resolve(__dirname, '../../src')` 77 | 78 | The full path to your `/src` directory. 79 | 80 | #### Yarn Workspaces 81 | 82 | To resolve your `src` directory when using yarn workspaces, use the srcPath option: 83 | 84 | ``` 85 | { 86 | resolve: 'gatsby-plugin-resolve-src', 87 | options: { 88 | srcPath: path.resolve(__dirname, 'src'), 89 | }, 90 | }, 91 | ``` -------------------------------------------------------------------------------- /gatsby-node.js: -------------------------------------------------------------------------------- 1 | const path = require('path') 2 | const fs = require('fs') 3 | 4 | exports.onCreateWebpackConfig = ({ actions }, options) => { 5 | const srcPath = options.srcPath || path.resolve(__dirname, '../../src') 6 | try { 7 | const stat = fs.statSync(srcPath) 8 | if(!stat.isDirectory) { 9 | console.warn(`gatsby-plugin-resolve-src: src path is not a directory ("${srcPath}")`) 10 | } 11 | } catch(err) { 12 | console.warn(`gatsby-plugin-resolve-src: src path not found at "${srcPath}"`) 13 | } 14 | actions.setWebpackConfig({ 15 | resolve: { 16 | modules: [srcPath, 'node_modules'], 17 | }, 18 | }) 19 | } 20 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gatsby-plugin-resolve-src", 3 | "version": "2.1.0", 4 | "description": "Gatsby plugin to allow resolving imports from the src subdirectory", 5 | "main": "gatsby-node.js", 6 | "repository": { 7 | "type": "git", 8 | "url": "git+https://github.com/alampros/gatsby-plugin-resolve-src.git" 9 | }, 10 | "keywords": [ 11 | "gatsby", 12 | "gatsby-plugin" 13 | ], 14 | "peerDependencies": { 15 | "gatsby": ">2.0.0-alpha" 16 | }, 17 | "author": "Aaron Lampros ", 18 | "license": "MIT", 19 | "bugs": { 20 | "url": "https://github.com/alampros/gatsby-plugin-resolve-src/issues" 21 | }, 22 | "homepage": "https://github.com/alampros/gatsby-plugin-resolve-src#readme" 23 | } 24 | --------------------------------------------------------------------------------