vx: clean up hand crafted paths

ealush · Apr 1, 2022 · b99e817 · b99e817 · vercel · Apr 1, 2022
1 parent bc01a88
commit b99e817
Show file tree

Hide file tree

Showing 11 changed files with 41 additions and 31 deletions.
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/vx/config/jest/jest.config.js b/vx/config/jest/jest.config.js
@@ -16,7 +16,7 @@ const ignoreGeneratedExports = moduleAliases().reduce((allExports, current) => {
 
   const x = path
     .join(...current.absolute.split(find))
-    .replace('.ts', '/package.json');
+    .replace('.ts', `/${opts.fileNames.PACKAGE_JSON}`);
 
   return allExports.concat(x);
 }, []);
@@ -49,7 +49,7 @@ module.exports = (custom = {}) => ({
     'ts-jest': {
       tsconfig: usePackage()
         ? vxPath.packageTsConfig()
-        : path.join(vxPath.ROOT_PATH, vxPath.TSCONFIG_JSON),
+        : path.join(vxPath.ROOT_PATH, opts.fileNames.TSCONFIG_JSON),
       diagnostics: {
         // Essentially ignoring "any" errors in TESTS
         ignoreCodes: [
@@ -69,11 +69,11 @@ module.exports = (custom = {}) => ({
   preset: 'ts-jest',
   rootDir: vxPath.ROOT_PATH,
   roots: ['<rootDir>'],
-  setupFiles: [path.resolve(vxPath.JEST_CONFIG_PATH, 'jest.setup.ts')].concat(
-    setupPerPackage
-  ),
+  setupFiles: [
+    path.resolve(vxPath.JEST_CONFIG_PATH, opts.fileNames.JEST_SETUP),
+  ].concat(setupPerPackage),
   setupFilesAfterEnv: [
-    path.resolve(vxPath.JEST_CONFIG_PATH, 'jest.setupAfterEnv.ts'),
+    path.resolve(vxPath.JEST_CONFIG_PATH, opts.fileNames.JEST_SETUP_AFTER_ENV),
   ].concat(setupAfterEnvPerPackage),
   testEnvironment: 'node',
   testMatch: [vxPath.packageSrc('*', `**/${opts.dir.TESTS}/*.(spec|test).ts`)],

diff --git a/vx/config/rollup/plugins/addCJSPackageJson.js b/vx/config/rollup/plugins/addCJSPackageJson.js
@@ -3,7 +3,6 @@ const path = require('path');
 const fse = require('fs-extra');
 
 const opts = require('vx/opts');
-const vxPath = require('vx/vxPath');
 
 module.exports = addEsPackageJson;
 
@@ -17,7 +16,7 @@ function addEsPackageJson() {
 
       const packageJsonPath = path.join(
         path.dirname(file),
-        vxPath.PACKAGE_JSON
+        opts.fileNames.PACKAGE_JSON
       );
 
       if (fse.existsSync(packageJsonPath)) {

diff --git a/vx/config/rollup/plugins/addModulePackageJson.js b/vx/config/rollup/plugins/addModulePackageJson.js
@@ -3,7 +3,6 @@ const path = require('path');
 const fse = require('fs-extra');
 
 const opts = require('vx/opts');
-const vxPath = require('vx/vxPath');
 
 module.exports = addEsPackageJson;
 
@@ -17,7 +16,7 @@ function addEsPackageJson() {
 
       const packageJsonPath = path.join(
         path.dirname(file),
-        vxPath.PACKAGE_JSON
+        opts.fileNames.PACKAGE_JSON
       );
 
       if (fse.existsSync(packageJsonPath)) {

diff --git a/vx/config/rollup/plugins/handleExports.js b/vx/config/rollup/plugins/handleExports.js
@@ -64,9 +64,13 @@ function writePackageJson(name, exportPath, { namespace } = {}) {
     pkgJson = { ...packageJson(name), ...pkgJson };
   }
 
-  fse.writeJSONSync(joinPath(exportPath, vxPath.PACKAGE_JSON), pkgJson, {
-    spaces: 2,
-  });
+  fse.writeJSONSync(
+    joinPath(exportPath, opts.fileNames.PACKAGE_JSON),
+    pkgJson,
+    {
+      spaces: 2,
+    }
+  );
 }
 
 function generatePackageJson(moduleName, namespace) {

diff --git a/vx/opts.js b/vx/opts.js
@@ -18,6 +18,8 @@ module.exports = {
     JEST_SETUP: 'jest.setup.ts',
     JEST_SETUP_AFTER_ENV: 'jest.setupAfterEnv.ts',
     MAIN_EXPORT: 'index.js',
+    PACKAGE_JSON: 'package.json',
+    TSCONFIG_JSON: 'tsconfig.json',
     VX_BUILD: 'vx.build.js',
   },
   format: {

diff --git a/vx/packageNames.js b/vx/packageNames.js
@@ -2,6 +2,7 @@ const path = require('path');
 
 const glob = require('glob');
 
+const opts = require('vx/opts');
 const { usePackage } = require('vx/vxContext');
 const vxPath = require('vx/vxPath');
 
@@ -16,7 +17,10 @@ module.exports = Object.defineProperty(
 );
 
 const paths = glob.sync(vxPath.package('*')).filter(packagePath => {
-  const packageJson = require(path.resolve(packagePath, vxPath.PACKAGE_JSON));
+  const packageJson = require(path.resolve(
+    packagePath,
+    opts.fileNames.PACKAGE_JSON
+  ));
 
   return !packageJson.private;
 });

diff --git a/vx/scripts/genTsConfig.js b/vx/scripts/genTsConfig.js
@@ -4,7 +4,6 @@ const lodash = require('lodash');
 
 const exec = require('vx/exec');
 const logger = require('vx/logger');
-const opts = require('vx/opts');
 const getModuleAliases = require('vx/util/moduleAliases');
 const vxPath = require('vx/vxPath');
 
@@ -56,7 +55,7 @@ function tsConfigTemplate() {
       sourceMap: true,
       strict: true,
     },
-    files: [`./${opts.dir.CONFIG}/jest/globals.d.ts`],
-    include: [`./${opts.dir.PACKAGES}/*/${opts.dir.SRC}/**/*.ts`],
+    files: [`${vxPath.rel(vxPath.JEST_CONFIG_PATH)}/globals.d.ts`],
+    include: [vxPath.rel(vxPath.packageSrc('*', '**/*.ts'))],
   };
 }
diff --git a/vx/util/moduleAliases.js b/vx/util/moduleAliases.js
@@ -5,12 +5,12 @@ const glob = require('glob');
 const opts = require('vx/opts');
 const vxPath = require('vx/vxPath');
 
-const matches = glob.sync(`./${opts.dir.PACKAGES}/*/${opts.dir.SRC}/**/*.ts`, {
+const matches = glob.sync(vxPath.rel(vxPath.packageSrc('*', '**/*.ts')), {
   cwd: vxPath.ROOT_PATH,
   absolute: false,
   ignore: [
-    `./${opts.dir.PACKAGES}/*/${opts.dir.SRC}/**/index.ts`,
-    `./${opts.dir.PACKAGES}/*/${opts.dir.SRC}/**/${opts.dir.TESTS}/**/*`,
+    vxPath.rel(vxPath.packageSrc('*', '**/*/index.ts')),
+    vxPath.rel(vxPath.packageSrc('*', `**/${opts.dir.TESTS}/**/*`)),
   ],
 });
 

diff --git a/vx/util/rootPackageJson.js b/vx/util/rootPackageJson.js
@@ -1,12 +1,13 @@
 const fs = require('fs');
 const path = require('path');
 
+const opts = require('vx/opts');
 const vxPath = require('vx/vxPath');
 
 function rootPackageJson() {
   // Manually reading it instead of requiring to avoid caching
   const jsonString = fs.readFileSync(
-    path.join(vxPath.ROOT_PATH, vxPath.PACKAGE_JSON),
+    path.join(vxPath.ROOT_PATH, opts.fileNames.PACKAGE_JSON),
     'utf8'
   );
   return JSON.parse(jsonString);

diff --git a/vx/vxPath.js b/vx/vxPath.js
@@ -6,16 +6,11 @@ const { usePackage } = require('vx/vxContext');
 
 const vxPath = {};
 
-const PACKAGE_JSON = 'package.json';
-const TSCONFIG_JSON = 'tsconfig.json';
 const VX = 'vx';
 
-vxPath.PACKAGE_JSON = PACKAGE_JSON;
-vxPath.TSCONFIG_JSON = TSCONFIG_JSON;
-
 vxPath.vxRoot = () => {
   return vxPath.closest(process.cwd(), (current, breakout) => {
-    const pkgJsonPath = path.resolve(current, PACKAGE_JSON);
+    const pkgJsonPath = path.resolve(current, opts.fileNames.PACKAGE_JSON);
 
     if (!fs.existsSync(pkgJsonPath)) {
       return;
@@ -50,11 +45,11 @@ vxPath.packageSrcExports = (pkgName = usePackage(), ...args) => {
 };
 
 vxPath.packageTsConfig = (pkgName = usePackage()) => {
-  return vxPath.package(pkgName, TSCONFIG_JSON);
+  return vxPath.package(pkgName, opts.fileNames.TSCONFIG_JSON);
 };
 
 vxPath.packageJson = (pkgName = usePackage()) => {
-  return vxPath.package(pkgName, PACKAGE_JSON);
+  return vxPath.package(pkgName, opts.fileNames.PACKAGE_JSON);
 };
 
 vxPath.closest = (start, predicate) => {
@@ -82,6 +77,10 @@ vxPath.closest = (start, predicate) => {
   }
 };
 
+vxPath.rel = absolutePath => {
+  return ['.', path.relative(vxPath.ROOT_PATH, absolutePath)].join(path.sep);
+};
+
 vxPath.ROOT_PATH = vxPath.vxRoot();
 
 vxPath.VX_ROOT_PATH = path.resolve(vxPath.ROOT_PATH, VX);
@@ -103,7 +102,10 @@ vxPath.JEST_CONFIG_FILE_PATH = path.resolve(
   opts.fileNames.JEST_CONFIG
 );
 
-vxPath.TSCONFIG_PATH = path.resolve(vxPath.ROOT_PATH, TSCONFIG_JSON);
+vxPath.TSCONFIG_PATH = path.resolve(
+  vxPath.ROOT_PATH,
+  opts.fileNames.TSCONFIG_JSON
+);
 
 vxPath.PACKAGES_PATH = path.resolve(vxPath.ROOT_PATH, opts.dir.PACKAGES);