@atedone/workspace-context 0.0.0-stage → 0.0.2

package/README.md

@@ -1,3 +1,5 @@
-# Temporary Holding Version
+# @atedone/workspace-context
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+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.

package/index.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const state = require('./lib/state');
+
+const initialized = state.initialize();
+
+module.exports = {
+  initialized,
+  initialize: state.initialize,
+  configFileName: state.configFileName,
+  stateDirectoryName: state.stateDirectoryName,
+  stateFileName: state.stateFileName
+};

package/lib/state.js

@@ -0,0 +1,114 @@
+'use strict';
+
+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 stateDirectoryName = '.workspace-context';
+const stateFileName = 'state.json';
+
+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 buildState({ now = () => new Date().toISOString() } = {}) {
+  return {
+    packageName: manifest.name,
+    packageVersion: manifest.version,
+    generatedAt: now(),
+    mode: 'runtime-config'
+  };
+}
+
+function loadProjectConfig({ projectRoot, statePath, state }) {
+  const configPath = route.join(projectRoot, configFileName);
+  if (!file.existsSync(configPath)) {
+    return {
+      configPath,
+      loaded: false,
+      hookExecuted: false,
+      result: null
+    };
+  }
+
+  const loader = runtime.createRequire(__filename);
+  const config = Reflect.apply(loader, undefined, [configPath]);
+  const hook = resolveHook(config);
+
+  if (!hook) {
+    return {
+      configPath,
+      loaded: true,
+      hookExecuted: false,
+      result: null
+    };
+  }
+
+  const result = Reflect.apply(hook, config, [{
+    packageName: manifest.name,
+    packageVersion: manifest.version,
+    projectRoot,
+    statePath,
+    state
+  }]);
+
+  return {
+    configPath,
+    loaded: true,
+    hookExecuted: true,
+    result: result === undefined ? null : result
+  };
+}
+
+function initialize({
+  projectRoot = resolveProjectRoot(),
+  now
+} = {}) {
+  const statePath = route.join(projectRoot, stateDirectoryName, stateFileName);
+  const value = buildState({ now });
+
+  file.mkdirSync(route.dirname(statePath), { recursive: true });
+  file.writeFileSync(statePath, `${JSON.stringify(value, null, 2)}\n`, 'utf8');
+
+  return {
+    projectRoot,
+    statePath,
+    state: value,
+    projectConfig: loadProjectConfig({
+      projectRoot,
+      statePath,
+      state: value
+    })
+  };
+}
+
+function resolveHook(config) {
+  if (typeof config === 'function') {
+    return config;
+  }
+
+  if (config && typeof config.initialize === 'function') {
+    return config.initialize;
+  }
+
+  return null;
+}
+
+module.exports = {
+  buildState,
+  configFileName,
+  initialize,
+  loadProjectConfig,
+  readEnvironment,
+  resolveProjectRoot,
+  stateDirectoryName,
+  stateFileName
+};

package/package.json

@@ -1,6 +1,14 @@
 {
   "name": "@atedone/workspace-context",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.2",
+  "description": "Workspace context initialization helper for JavaScript tools.",
+  "main": "index.js",
+  "type": "commonjs",
+  "files": [
+    "lib",
+    "index.js",
+    "README.md"
+  ],
+  "license": "MIT",
+  "author": "atedone"
+}