Merge pull request #72 from oklas/task-10

Add baseUrl support

Author: oklas

.gitignore

@@ -2,3 +2,4 @@ node_modules
 example/*/node_modules
 test/dists
 coverage
+.DS_Store

README.md

@@ -180,15 +180,32 @@ and replace `react-scripts` in `package.json`:
   }
 ```
 
+
+#### Using baseUrl
+
+* **`baseUrl = '.'`**
+
+  * able to create alias outside of `src` (near `src`)
+  * for each directory in `src` alias **does not** created automatically (must be declared manually)
+
+* **baseUrl = 'src'**
+
+  * alias outside of `src` is not possible, only in directory specified in `baseUrl`
+  * for each folder in `src` alias created automatically with same name as folder
+
+See also experimental [autoscan](https://github.com/oklas/react-app-alias/issues/70) feature
+
+
 #### API
 
 * **options**
 
 ```ts
   Options {
     alias?: { [alias: string]: string }; // optional alias map
-    tsconfig?: string, // optinal tsconfig.json path
-    jsconfig?: string, // options jsconfig.json path
+    tsconfig?: string, // optional tsconfig.json path
+    jsconfig?: string, // optional jsconfig.json path
+    baseUrl?: string, // optional by default from config
   }
 ```
 

example/above/src/App.test.tsx

@@ -8,6 +8,12 @@ test('renders text', () => {
   expect(linkElement).toBeInTheDocument();
 });
 
+test('renders internal component from src', () => {
+  render(<App />);
+  const nearElement = screen.getByText(/Internal/i);
+  expect(nearElement).toBeInTheDocument();
+});
+
 test('renders component from near src', () => {
   render(<App />);
   const nearElement = screen.getByText(/Near Src/i);

example/above/src/App.tsx

@@ -1,13 +1,15 @@
 import React from 'react'
-import NearSrc from 'near-src/NearSrc'
 import AboveRootJs from 'above-root-js/AboveRootJs'
 import AboveRootTs from 'above-root-ts/AboveRootTs'
+import NearSrc from 'near-src/NearSrc'
+import Internal from 'InternalEx/index'
 import './App.css'
 
 function App() {
   return (
     <div className="App">
       <h2>Main</h2>
+      <Internal />
       <NearSrc />
       <AboveRootJs/>
       <AboveRootTs />

example/above/src/InternalEx/index.tsx

@@ -0,0 +1,9 @@
+import React from 'react'
+
+function Internal() {
+  return (
+    <h3>Internal</h3>
+  )
+}
+
+export default Internal

example/above/tsconfig.paths.json

@@ -4,7 +4,8 @@
     "paths": {
       "above-root-ts/*": [ "../above-root-ts/src/*" ],
       "above-root-js/*": [ "../above-root-js/src/*" ],
-      "near-src/*": [ "near-src/src/*" ]
+      "near-src/*": [ "near-src/src/*" ],
+      "InternalEx/*": [ "src/InternalEx/*" ]
     }
   }
 }

example/above/yarn.lock

@@ -9181,18 +9181,6 @@ [email protected]:
     iconv-lite "0.4.24"
     unpipe "1.0.0"
 
-react-app-alias-ex@^0.0.0:
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/react-app-alias-ex/-/react-app-alias-ex-1.0.0.tgz#d41a7c16be47915f6955fde2feeb1caeb3c55372"
-  integrity sha512-PIf7d+tZhJiwsBIzvBDYtWBuO/xhlRW2Jaxny4MfqnkSHPocAhD97a051Q7QMtiBEDt2WmFrBfVZ5Zx3IhjgPw==
-  dependencies:
-    react-app-alias "^0.0.0"
-
-react-app-alias@^0.0.0:
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/react-app-alias/-/react-app-alias-1.0.0.tgz#8c644e0f537e802e0a7de7d0cba327d1caee45ca"
-  integrity sha512-rOA8TKlN932zFCjnZjWzvTk9GLs7b6dgj2BDpJ3Pvi5oxpVvaGHroAL//YxEXxJiLE3lFLchTfAD9FbN7/SChQ==
-
 react-app-polyfill@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/react-app-polyfill/-/react-app-polyfill-2.0.0.tgz#a0bea50f078b8a082970a9d853dc34b6dcc6a3cf"

example/below/.gitignore

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

example/below/README.md

@@ -0,0 +1,12 @@
+# Demo
+
+This example demonstrate base `alias` implementation (without `above root` imports)
+
+*Configuration (with `above root`) imports is in `example/above` directory*
+
+Here is example for crete-react-app versions 4.1 and above
+
+The version 4.0 of create-react-app requires patch due to
+[create-react-app #9921](https://github.com/facebook/create-react-app/pull/9921)
+The example with patch available [here](https://github.com/oklas/react-app-rewire-alias/tree/055bd2fd79dd391b2b79be15dcaa2a78b7779e8e/example/main) use yarn (yarn.lock)
+

example/below/config-overrides.js

@@ -0,0 +1,7 @@
+const {aliasWebpack, aliasJest} = require('react-app-alias')
+
+const options = {
+}
+
+module.exports = aliasWebpack(options)
+module.exports.jest = aliasJest(options)