aberlaas-helper 2.10.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Tim Carry (tim@pixelastic.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/lib/main.js

@@ -0,0 +1,98 @@
+import path from 'path';
+import { _ } from 'golgoth';
+import { exists, firostImport, glob } from 'firost';
+
+export default {
+  /**
+   * Return absolute path to the host dir
+   * @returns {string} Absolute path to host dir
+   */
+  hostRoot() {
+    return process.cwd();
+  },
+  /**
+   * Return an absolute path to a file in the host
+   * @param {string} relativePath Relative path from the host root
+   * @returns {string} Absolute path to the host file
+   */
+  hostPath(relativePath = '') {
+    return path.resolve(this.hostRoot(), relativePath);
+  },
+  /**
+   * Find files in host directory following glob patterns. Will exclude some
+   * directories by default, and allow specifying only specific file extensions
+   * @param {Array} userPattern Patterns to match
+   * @param {Array} safeExtensions Optional array of extensions to safelist. If
+   * set, only files of this extensions will be returned
+   * @returns {Array} Array of files matching the patterns
+   */
+  async findHostFiles(userPattern, safeExtensions = []) {
+    const patterns = _.castArray(userPattern);
+    // Making all path relative to the host
+    const globs = _.map(patterns, (pattern) => {
+      return this.hostPath(pattern);
+    });
+
+    // Exclude folders that shouldn't be included
+    const blockedFolders = [
+      'build',
+      'dist',
+      'fixtures',
+      'node_modules',
+      'tmp',
+      'vendors',
+      '.git',
+      '.yarn',
+    ];
+    _.each(blockedFolders, (blockedFolder) => {
+      const deepFolder = `**/${blockedFolder}/**`;
+      globs.push(`!${this.hostPath(deepFolder)}`);
+    });
+
+    // Expanding globs
+    let allFiles = await glob(globs, { directories: false });
+
+    if (_.isEmpty(safeExtensions)) {
+      return allFiles;
+    }
+
+    // Keep only files of specified extensions
+    allFiles = _.filter(allFiles, (filepath) => {
+      const extension = path.extname(filepath);
+      const extensionWithoutDot = _.replace(extension, '.', '');
+      return (
+        _.includes(safeExtensions, extension) ||
+        _.includes(safeExtensions, extensionWithoutDot)
+      );
+    });
+
+    return allFiles;
+  },
+  /**
+   * Return a config object for a specific tool.
+   * Will first check for the user supplied path to the config file, then
+   * fallback to the default config file in the host, and finally fallback to
+   * the default base config in the aberlaas module.
+   * @param {string} userConfigPath User specified config file, relative to the host root
+   * @param {string} hostConfigPath Default host config path, relative to the host root
+   * @param {object} baseConfig Base aberlaas config, final fallback
+   * @returns {object} Config object
+   */
+  async getConfig(userConfigPath, hostConfigPath, baseConfig = {}) {
+    // Taking value from --config in CLI in priority
+    if (userConfigPath) {
+      return await firostImport(this.hostPath(userConfigPath));
+    }
+
+    // Checking for custom config in the host
+    if (hostConfigPath) {
+      const hostConfigFullPath = this.hostPath(hostConfigPath);
+      if (await exists(hostConfigFullPath)) {
+        return await firostImport(hostConfigFullPath);
+      }
+    }
+
+    // Fallback on default config in aberlaas
+    return baseConfig;
+  },
+};

package/lib/versions.js

@@ -0,0 +1,13 @@
+export const nodeVersion = '18.18.0';
+export const yarnVersion = '4.5.0';
+export const norskaVersion = '2.9.0';
+export const norskaThemeDocsVersion = '5.0.3';
+export const lernaVersion = '4.0.0';
+
+export default {
+  nodeVersion,
+  yarnVersion,
+  norskaVersion,
+  norskaThemeDocsVersion,
+  lernaVersion,
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "aberlaas-helper",
+  "type": "module",
+  "description": "aberlaas shared helper: Common methods used by all commands",
+  "version": "2.10.0",
+  "repository": "pixelastic/aberlaas",
+  "homepage": "https://projects.pixelastic.com/aberlaas/",
+  "author": "Tim Carry (@pixelastic)",
+  "license": "MIT",
+  "files": [
+    "lib/*.js"
+  ],
+  "exports": {
+    ".": "./lib/main.js"
+  },
+  "main": "./lib/main.js",
+  "engines": {
+    "node": ">=18.18.0"
+  },
+  "scripts": {
+    "build": "../../scripts/local/build",
+    "build:prod": "../../scripts/local/build-prod",
+    "cms": "../../scripts/local/cms",
+    "serve": "../../scripts/local/serve",
+    "ci": "../../scripts/local/ci",
+    "release": "../../scripts/local/release",
+    "update": "node ../../scripts/meta/update.js",
+    "test:meta": "../../scripts/local/test-meta",
+    "test": "../../scripts/local/test",
+    "test:watch": "../../scripts/local/test-watch",
+    "compress": "../../scripts/local/compress",
+    "lint": "../../scripts/local/lint",
+    "lint:fix": "../../scripts/local/lint-fix"
+  },
+  "dependencies": {
+    "find-up": "7.0.0",
+    "firost": "4.3.0",
+    "golgoth": "2.4.0"
+  },
+  "gitHead": "bcdaf87c198a588e02b5539c222f611e356d3079"
+}