Create rc of analytics node (#587)

create analytics-node (priv ATM),  @internal/config (priv), plugin-validation (public)

Co-authored-by: Seth Silesky <silesky@users.noreply.github.com>

Author: silesky

.changeset/friendly-birds-happen.md

@@ -0,0 +1,6 @@
+---
+'@segment/analytics-plugin-validation': major
+'@segment/analytics-core': minor
+---
+
+Migrate common code into core.

constraints.pro

@@ -26,7 +26,12 @@ gen_enforced_dependency(WorkspaceCwd, DependencyIdent, DependencyRange2, Depende
   \+ member(DependencyIdent, [
     % Allow examples to use different versions of react and
     'react', 'react-dom',
-    '@types/react'
+    '@types/react',
+    % Allow the usage of workspace^ -- there is a better way to do this =)
+    '@segment/analytics-next',
+    '@segment/analytics-node',
+    '@segment/analytics-core',
+    '@internal/config'
   ]).
 
 % Enforces that a dependency doesn't appear in both `dependencies` and `devDependencies`

internal/README.md

@@ -0,0 +1,3 @@
+# @internal/*
+
+Internal packages are private and never published to npm. Internal packages may _only_ be installed as devDependencies (if installed in a public package).

internal/config/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@internal/config",
+  "version": "0.0.0",
+  "private": true,
+  "main": "./src",
+  "packageManager": "yarn@3.2.1"
+}

internal/config/src/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+  createJestTSConfig: require('./jest/config').createJestTSConfig,
+  lintStagedConfig: require('./lint-staged/config'),
+}

internal/config/src/jest/config.js

@@ -0,0 +1,34 @@
+const { getJestModuleMap } = require('./get-module-map')
+
+/**
+ * Create Config
+ * @param {import('jest').Config} Overrides.
+ * @param {object} getJestModuleMap options.
+ * @returns {import('jest').Config}
+ */
+const createJestTSConfig = (
+  { modulePathIgnorePatterns, testMatch, ...overridesToMerge } = {},
+  { packageRoot, skipPackageMap } = {}
+) => {
+  return {
+    moduleNameMapper: getJestModuleMap(packageRoot, skipPackageMap),
+    preset: 'ts-jest',
+    modulePathIgnorePatterns: [
+      '<rootDir>/dist/',
+      ...(modulePathIgnorePatterns || []),
+    ],
+    testEnvironment: 'node',
+    testMatch: ['**/?(*.)+(test).[jt]s?(x)', ...(testMatch || [])],
+    clearMocks: true,
+    globals: {
+      'ts-jest': {
+        isolatedModules: true,
+      },
+    },
+    ...(overridesToMerge || {}),
+  }
+}
+
+module.exports = {
+  createJestTSConfig,
+}

internal/config/src/jest/get-module-map.js

@@ -0,0 +1,31 @@
+const getPackages = require('get-monorepo-packages')
+
+// do not map modules in CI to catch any package install bugs (slower)... not in use ATM
+const doNotMapPackages = process.env.JEST_SKIP_PACKAGE_MAP === 'true'
+
+/**
+ * Allows ts-jest to dynamically resolve packages so "build"
+ */
+const getJestModuleMap = (
+  packageRoot = '../../',
+  skipPackageMap = doNotMapPackages
+) => {
+  // get listing of packages in the mono repo
+  const createLocation = (name) => {
+    return `<rootDir>/./${name}/src/$1`
+  }
+  const moduleNameMapper = getPackages(packageRoot).reduce(
+    (acc, el) => ({
+      ...acc,
+      [`${el.package.name}(.*)$`]: createLocation(el.location),
+    }),
+    {}
+  )
+
+  return {
+    '@/(.+)': '<rootdir>/../../src/$1',
+    ...(skipPackageMap ? {} : moduleNameMapper),
+  }
+}
+
+module.exports = { getJestModuleMap }

internal/config/src/lint-staged/config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  '*.{js,jsx,ts,tsx}': ['eslint --fix'],
+  '*.json*': ['prettier --write'],
+}

package.json

@@ -4,31 +4,31 @@
   "version": "0.0.0",
   "workspaces": [
     "examples/*",
-    "packages/*"
+    "packages/*",
+    "internal/*"
   ],
   "engines": {
     "node": "^14.15.0"
   },
   "scripts": {
-    "test": "turbo run test",
+    "test": "FORCE_COLOR=1 turbo run test --filter='./packages/*'",
     "test:scripts": "jest --config scripts/jest.config.js",
     "lint": "yarn constraints && turbo run lint",
-    "build": "turbo run build",
-    "build:packages": "turbo run build --filter='./packages/*'",
+    "build": "turbo run build --filter='./packages/*'",
     "watch": "turbo run watch --filter='./packages/*'",
     "dev": "yarn workspace with-next-js run dev",
     "postinstall": "husky install",
     "changeset": "changeset",
     "update-versions-and-changelogs": "changeset version && yarn version-run-all && bash scripts/update-lockfile.sh",
-    "release": "yarn build:packages --force && changeset publish && yarn postpublish-run-all && git push origin --tags --no-verify",
+    "release": "yarn build --force && changeset publish && yarn postpublish-run-all && git push origin --tags --no-verify",
     "postpublish-run-all": "yarn workspaces foreach -vpt --no-private run postpublish",
     "version-run-all": "yarn workspaces foreach -vpt --no-private run version",
     "core": "yarn workspace @segment/analytics-core",
-    "core+deps": "turbo run --filter='analytics-core'",
+    "core+deps": "turbo run --filter=@segment/analytics-core...",
     "browser": "yarn workspace @segment/analytics-next",
-    "browser+deps": "turbo run --filter='analytics-next'",
+    "browser+deps": "turbo run --filter=@segment/analytics-next...",
     "node": "yarn workspace @segment/analytics-node",
-    "node+deps": "turbo run --filter='analytics-node'",
+    "node+deps": "turbo run --filter=@segment/analytics-node...",
     "clean": "bash scripts/clean.sh"
   },
   "packageManager": "yarn@3.2.1",

packages/browser/.lintstagedrc.js

@@ -1,3 +1 @@
-module.exports = {
-  '*.{js,jsx,ts,tsx}': ['eslint --fix'],
-}
+module.exports = require("@internal/config").lintStagedConfig