feat: adding settings for using @src as an import alias

Author: jacobo-dominguez-wgu

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openedx/frontend-base",
-  "version": "1.0.0-alpha.7",
+  "version": "1.0.0-alpha.8",
   "description": "Build tools, setup and config for frontend apps",
   "publishConfig": {
     "access": "public"

runtime/jest.config.js

@@ -7,6 +7,7 @@ module.exports = {
     '\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir/__mocks__/file.js',
     '\\.(css|scss)$': require.resolve('identity-obj-proxy'),
     'site.config': '<rootDir>/site.config.test.tsx',
+    '^@src/(.*)$': '<rootDir>/src/$1',
   },
   testEnvironment: 'jsdom',
   testEnvironmentOptions: {

shell/jest.config.js

@@ -7,6 +7,7 @@ module.exports = {
     '\\.(jpg|jpeg|png|gif|eot|otf|webp|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$': '<rootDir>/__mocks__/file.js',
     '\\.(css|scss)$': require.resolve('identity-obj-proxy'),
     'site.config': '<rootDir>/site.config.test.tsx',
+    '^@src/(.*)$': '<rootDir>/src/$1',
   },
   testEnvironment: 'jsdom',
   testEnvironmentOptions: {

tools/jest/jest.config.js

@@ -9,6 +9,7 @@ module.exports = {
   moduleNameMapper: {
     '\\.(css|scss)$': require.resolve('identity-obj-proxy'),
     'site.config': path.resolve(process.cwd(), './site.config.test.tsx'),
+    '^@src/(.*)$': '<rootDir>/src/$1',
   },
   collectCoverageFrom: [
     'src/**/*.{js,jsx,ts,tsx}',

tools/tsconfig.json

@@ -6,6 +6,9 @@
     "noEmit": false,
     "allowJs": true,
     "resolveJsonModule": true,
+    "paths": {
+      "@src/*": ["./src/*"]
+    }
   },
   "include": [
     "babel/**/*",

tools/webpack/webpack.config.build.ts

@@ -36,6 +36,7 @@ const config: Configuration = {
     alias: {
       ...aliases,
       'site.config': resolvedSiteConfigPath,
+      '@src': path.resolve(process.cwd(), 'src'),
     },
     extensions: ['.js', '.jsx', '.ts', '.tsx'],
   },

tools/webpack/webpack.config.dev.shell.ts

@@ -34,6 +34,7 @@ const config: Configuration = {
     alias: {
       ...aliases,
       'site.config': resolvedSiteConfigPath,
+      '@src': path.resolve(process.cwd(), 'src'),
     },
     extensions: ['.js', '.jsx', '.ts', '.tsx'],
   },

tools/webpack/webpack.config.dev.ts

@@ -33,6 +33,7 @@ const config: Configuration = {
     alias: {
       ...aliases,
       'site.config': resolvedSiteConfigPath,
+      '@src': path.resolve(process.cwd(), 'src'),
     },
     extensions: ['.js', '.jsx', '.ts', '.tsx'],
   },

tsconfig.json

@@ -3,6 +3,9 @@
   "compilerOptions": {
     "rootDir": ".",
     "outDir": "dist",
+    "paths": {
+      "@src/*": ["./src/*"]
+    }
   },
   "include": [
     "runtime/**/*",