@emulsify/core 0.0.0-development

package/.cli/init.js

@@ -0,0 +1,168 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const yaml = require('js-yaml');
+
+/**
+ * Returns a boolean indicating whether or not the given object is a literal object.
+ *
+ * @param {any} obj object who's type will be checked.
+ * @returns {boolean} boolean indicating whether or not the given obj is a literal object.
+ */
+const isObjectLiteral = (obj) =>
+  obj != null && obj.constructor.name === 'Object';
+
+/**
+ * Attempts to require the project.emulsify.json file.
+ *
+ * @returns parsed project.emulsify.json file.
+ */
+const getEmulsifyConfig = () => {
+  try {
+    return require('../config/project.emulsify.json');
+  } catch (e) {
+    throw new Error(
+      `Unable to load an Emulsify project config file (project.emulsify.json): ${String(
+        e,
+      )}`,
+    );
+  }
+};
+
+/**
+ * Throws if the given emulsify config file is invalid.
+ *
+ * @param {*} config emulsify project config, as loaded from a project.emulsify.json file.
+ */
+const validateEmulsifyConfig = (config) => {
+  const prefix = 'Invalid project.emulsify.json config file';
+  const example = JSON.stringify({
+    project: {
+      name: 'Example Project',
+      machineName: 'example-project',
+    },
+  });
+
+  if (!config) {
+    throw new Error(`${prefix}.`);
+  }
+
+  if (!config.project || !isObjectLiteral(config.project)) {
+    throw new Error(
+      `${prefix}: Must contain a "project" key, with a name and machineName property. ${example}`,
+    );
+  }
+
+  if (typeof config.project.name !== 'string') {
+    throw new Error(
+      `${prefix}: the "project" object must contain a "name" key with a string value. ${example}`,
+    );
+  }
+
+  if (typeof config.project.machineName !== 'string') {
+    throw new Error(
+      `${prefix}: the "project" object must contain a "machineName" key with a string value. ${example}`,
+    );
+  }
+};
+
+/**
+ * Takes an array of objects describing the origin and destination of a given file,
+ * then moves each specified file according to it's to/from properties.
+ *
+ * @param {Array<{ to: string, from: string }>} files array of objects depicting the origin and destination of a given file.
+ * @returns void.
+ */
+const renameFiles = (files) =>
+  files.map(({ from, to }) =>
+    fs.renameSync(path.join(__dirname, from), path.join(__dirname, to)),
+  );
+
+/**
+ * Takes a machineName, and returns a fn that, when called with a str,
+ * replaces all instances of `emulsify` with the given machineName.
+ *
+ * @param {string} machineName string that should replace emulsify.
+ * @returns {function} fn that when called with a str, replaces all instances of `emulsify` with the given machineName.
+ */
+const strReplaceEmulsify = (machineName) => (str) =>
+  str.replace(/emulsify/g, machineName);
+
+/**
+ * Loads a yml file at filePath, applies the functor to the contents of the file, and writes it.
+ *
+ * @param {string} filePath path to the file that should be loaded, modified, and re-saved.
+ * @param {fn} functor fn that should return the new contents of the file, to be saved.
+ * @returns void.
+ */
+const applyToYmlFile = (filePath, functor) => {
+  if (!filePath || typeof filePath !== `string`) {
+    throw new Error(
+      `Cannot modify a file without knowing how to access it: ${filePath}`,
+    );
+  }
+  if (typeof functor !== 'function') {
+    return;
+  }
+
+  const file = yaml.load(fs.readFileSync(filePath, 'utf8'));
+  fs.writeFileSync(filePath, yaml.dump(functor(file)));
+};
+
+const main = () => {
+  // Load up config file, throw if none exists.
+  const config = getEmulsifyConfig();
+
+  // Validate config file, throw if it is missing
+  //properties or is otherwise malformed.
+  validateEmulsifyConfig(config);
+
+  const {
+    project: { machineName, name },
+  } = config;
+
+  // Move all files to their correct location.
+  renameFiles([
+    {
+      from: '../emulsify.info.yml',
+      to: `../${machineName}.info.yml`,
+    },
+    {
+      from: '../emulsify.theme',
+      to: `../${machineName}.theme`,
+    },
+    {
+      from: '../emulsify.breakpoints.yml',
+      to: `../${machineName}.breakpoints.yml`,
+    },
+    {
+      from: '../emulsify.libraries.yml',
+      to: `../${machineName}.libraries.yml`,
+    },
+  ]);
+
+  // Update info.yml file.
+  applyToYmlFile(
+    path.join(__dirname, `../${machineName}.info.yml`),
+    (info) => ({
+      ...info,
+      name: machineName,
+      libraries: info.libraries.map(strReplaceEmulsify(machineName)),
+    }),
+  );
+
+  // Update breakpoint.yml file.
+  applyToYmlFile(
+    path.join(__dirname, `../${machineName}.breakpoints.yml`),
+    (breakpoints) => {
+      const newBps = {};
+      for (const prop of Object.keys(breakpoints)) {
+        newBps[strReplaceEmulsify(machineName)(prop)] = breakpoints[prop];
+      }
+      return newBps;
+    },
+  );
+};
+
+main();

package/.editorconfig

@@ -0,0 +1,5 @@
+# Unix-style newlines with a newline ending every file
+[*]
+indent_style = space
+indent_size = 2
+insert_final_newline = true

package/.eslintignore

@@ -0,0 +1,2 @@
+**/*.min.js
+**/node_modules/**/*

package/.github/ISSUE_TEMPLATE/BUG_REPORT_TEMPLATE.md

@@ -0,0 +1,18 @@
+### Describe the bug
+_A clear and concise description of what the bug is._
+
+### Steps to reproduce the bug
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+### Expected behavior
+A clear and concise description of what you expected to happen.
+
+### Suggested solution or approach:
+_(optional) Describe a solution or approach to your request that may help with implementation._
+
+### Additional context
+_(optional) Add any other context or screenshots about the feature request here._

package/.github/ISSUE_TEMPLATE/FEATURE_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Emulsify Core Version:
+- [1.0.0](https://github.com/emulsify-ds/emulsify-core/releases)):
+
+### Description of the feature request:
+_Please give as much information as possible_ 
+
+### Suggested solution or approach:
+_(optional) Describe a solution or approach to your request that may help with implementation._
+
+### Additional context:
+_(optional) Add any other context or screenshots about the feature request here._

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+**This PR does the following:**
+- Adds functionality bullet item
+- Fixes this or that bullet item
+  
+### Related Issue(s)
+- [Title of the issue](https://github.com/emulsify-ds/emulsify-core/issues/1)
+
+### Notes:
+- (optional) Document any intentionally unfinished parts or known issues within this PR
+
+### Functional Testing:
+- [ ] Document steps that allow someone to fully test your code changes. Include screenshot and links when appropriate.
+
+### Security
+_Security checks that should be reviewed_
+
+### Accessibility
+_Should this be checked for this feature?_
+

package/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: "/"
+    schedule:
+      interval: weekly

package/.github/workflows/addtoprojects.yml

@@ -0,0 +1,21 @@
+name: Add to projects
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add issue to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v0.3.0
+        with:
+          # You can target a repository in a different organization
+          # to the issue
+          project-url: https://github.com/orgs/emulsify-ds/projects/6
+          github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}

package/.github/workflows/contributors.yml

@@ -0,0 +1,23 @@
+name: Add contributors
+on:
+  schedule:
+    - cron: "20 20 * * *"
+  push:
+    branches:
+      - master
+
+jobs:
+  add-contributors:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: BobAnkh/add-contributors@master
+        with:
+          CONTRIBUTOR: "### Contributors"
+          COLUMN_PER_ROW: "6"
+          ACCESS_TOKEN: ${{secrets.ADD_TO_PROJECT_PAT}}
+          IMG_WIDTH: "100"
+          FONT_SIZE: "14"
+          PATH: "/README.md"
+          COMMIT_MESSAGE: "docs(README): update contributors"
+          AVATAR_SHAPE: "round"

package/.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+name: Lint
+on:
+  push:
+    branches: [develop, main]
+  pull_request:
+    branches: [develop, main]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 20
+      - name: Install
+        run: npm install
+      - name: Lint
+        run: npm run lint

package/.github/workflows/semantic-release.yml

@@ -0,0 +1,24 @@
+name: Semantic Release on Merge
+on:
+  push:
+    branches: [main]
+jobs:
+  release:
+    name: Attempt Semantic Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Install Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 20
+      - name: Install
+        run: npm install
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm run semantic-release

package/.history/.releaserc_20240607133550

@@ -0,0 +1,11 @@
+module.exports = {
+  tagFormat: '${version}',
+  branches: ['main'],
+  repositoryUrl: 'git@github.com:emulsify-ds/emulsify-core.git',
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    ['@semantic-release/npm', { npmPublish: false }],
+    '@semantic-release/github',
+  ],
+};

package/.history/.releaserc_20240607134831

@@ -0,0 +1,18 @@
+{
+  "tagFormat": "${version}",
+  "branches": [
+    "main"
+  ],
+  "repositoryUrl": "git@github.com:emulsify-ds/emulsify-core.git",
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": false
+      }
+    ],
+    "@semantic-release/github"
+  ]
+}

package/.history/.releaserc_20240607135005

@@ -0,0 +1,11 @@
+module.exports = {
+  tagFormat: '${version}',
+  branches: ['main'],
+  repositoryUrl: 'git@github.com:emulsify-ds/emulsify-core.git',
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    ['@semantic-release/npm', { npmPublish: false }],
+    '@semantic-release/github',
+  ],
+};

package/.history/package_20240607132936.json

@@ -0,0 +1,121 @@
+{
+  "name": "emulsify-core",
+  "version": "1.0.0",
+  "description": "Storybook development + Webpack Build",
+  "keywords": [
+    "component library",
+    "design system",
+    "drupal",
+    "pattern library",
+    "storybook",
+    "styleguide"
+  ],
+  "author": "Four Kitchens <shout@fourkitchens.com>",
+  "license": "ISC",
+  "scripts": {
+    "coverage": "npm run test && open-cli .coverage/lcov-report/index.html",
+    "format": "npm run lint-fix; npm run prettier-fix",
+    "husky:commit-msg": "commitlint --edit $1",
+    "husky:pre-commit": "npm run lint",
+    "lint": "npm run lint-js",
+    "lint-fix": "npm run lint-js -- --fix",
+    "lint-js": "eslint --config config/eslintrc.config.json --no-error-on-unmatched-pattern ./config ./storybook",
+    "lint-staged": "lint-staged",
+    "prepare": "[ -d '.git' ] && (husky install) || true",
+    "prettier": "prettier --config config/prettierrc.json --ignore-unknown \"**/*.{js,yml,scss,md}\"",
+    "prettier-fix": "prettier --config config/prettierrc.json --write --ignore-unknown \"**/*.{js,yml,scss,md}\"",
+    "semantic-release": "semantic-release",
+    "storybook": "storybook dev --ci -s ../../dist,../../assets/images,../../assets/icons,../../assets/videos -p 6006",
+    "storybook-build": "storybook build -s ../../dist,../../assets/images,../../assets/icons,../../assets/videos -o .out",
+    "storybook-deploy": "storybook-to-ghpages -o .out",
+    "test": "jest --coverage  --config ./config/jest.config.js",
+    "twatch": "jest --no-coverage --watch --verbose"
+  },
+  "dependencies": {
+    "@babel/core": "^7.24.0",
+    "@babel/eslint-parser": "^7.23.10",
+    "@emulsify/cli": "^1.6.0",
+    "@storybook/addon-a11y": "^7.6.17",
+    "@storybook/addon-actions": "^7.6.17",
+    "@storybook/addon-essentials": "^7.6.17",
+    "@storybook/addon-links": "^7.6.17",
+    "@storybook/addon-styling-webpack": "^1.0.0",
+    "@storybook/addon-themes": "^7.6.17",
+    "@storybook/html": "^7.6.17",
+    "@storybook/html-webpack5": "^7.6.17",
+    "add-attributes-twig-extension": "^0.1.0",
+    "autoprefixer": "^10.4.19",
+    "babel-loader": "^9.1.3",
+    "babel-preset-minify": "^0.5.2",
+    "bem-twig-extension": "^0.1.1",
+    "breakpoint-sass": "^3.0.0",
+    "chalk": "^5.2.0",
+    "clean-webpack-plugin": "^4.0.0",
+    "concurrently": "^8.2.2",
+    "css-loader": "^7.1.1",
+    "eslint": "^8.57.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-security": "^2.1.1",
+    "eslint-plugin-storybook": "^0.8.0",
+    "eslint-webpack-plugin": "^4.1.0",
+    "file-loader": "^6.2.0",
+    "fs-extra": "^11.2.0",
+    "glob": "^10.3.12",
+    "graceful-fs": "^4.2.11",
+    "html-webpack-plugin": "^5.6.0",
+    "imagemin-webpack-plugin": "^2.4.2",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "js-yaml": "^4.1.0",
+    "js-yaml-loader": "^1.2.2",
+    "lint-staged": "^15.2.2",
+    "mini-css-extract-plugin": "^2.9.0",
+    "node-sass-glob-importer": "^5.3.3",
+    "normalize.css": "^8.0.1",
+    "open-cli": "^8.0.0",
+    "pa11y": "^7.0.0",
+    "postcss": "^8.4.38",
+    "postcss-loader": "^8.1.1",
+    "postcss-scss": "^4.0.9",
+    "ramda": "^0.29.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "regenerator-runtime": "^0.14.1",
+    "sass": "^1.75.0",
+    "sass-loader": "^14.2.1",
+    "storybook": "^7.6.17",
+    "style-dictionary": "^3.9.2",
+    "stylelint": "^16.3.1",
+    "stylelint-config-standard-scss": "^13.1.0",
+    "stylelint-prettier": "^5.0.0",
+    "stylelint-selector-bem-pattern": "^4.0.0",
+    "stylelint-webpack-plugin": "^5.0.0",
+    "svg-sprite-loader": "^6.0.11",
+    "token-transformer": "^0.0.33",
+    "twig-drupal-filters": "^3.2.0",
+    "twig-loader": "github:fourkitchens/twig-loader",
+    "twig-testing-library": "^1.2.0",
+    "webpack": "^5.91.0",
+    "webpack-cli": "^5.1.4",
+    "webpack-merge": "^5.10.0",
+    "yaml": "^2.4.1"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.2.0",
+    "@commitlint/config-conventional": "^19.1.0",
+    "@semantic-release/changelog": "^6.0.2",
+    "@semantic-release/commit-analyzer": "^11.1.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^10.0.2",
+    "@semantic-release/release-notes-generator": "^12.1.0",
+    "husky": "^9.0.11",
+    "semantic-release": "^23.0.4"
+  },
+  "overrides": {
+    "graceful-fs": "^4.2.11"
+  }
+}

package/.history/package_20240607135135.json

@@ -0,0 +1,121 @@
+{
+  "name": "@emulsify/core",
+  "version": "1.0.0",
+  "description": "Storybook development + Webpack Build",
+  "keywords": [
+    "component library",
+    "design system",
+    "drupal",
+    "pattern library",
+    "storybook",
+    "styleguide"
+  ],
+  "author": "Four Kitchens <shout@fourkitchens.com>",
+  "license": "ISC",
+  "scripts": {
+    "coverage": "npm run test && open-cli .coverage/lcov-report/index.html",
+    "format": "npm run lint-fix; npm run prettier-fix",
+    "husky:commit-msg": "commitlint --edit $1",
+    "husky:pre-commit": "npm run lint",
+    "lint": "npm run lint-js",
+    "lint-fix": "npm run lint-js -- --fix",
+    "lint-js": "eslint --config config/eslintrc.config.json --no-error-on-unmatched-pattern ./config ./storybook",
+    "lint-staged": "lint-staged",
+    "prepare": "[ -d '.git' ] && (husky install) || true",
+    "prettier": "prettier --config config/prettierrc.json --ignore-unknown \"**/*.{js,yml,scss,md}\"",
+    "prettier-fix": "prettier --config config/prettierrc.json --write --ignore-unknown \"**/*.{js,yml,scss,md}\"",
+    "semantic-release": "semantic-release",
+    "storybook": "storybook dev --ci -s ../../dist,../../assets/images,../../assets/icons,../../assets/videos -p 6006",
+    "storybook-build": "storybook build -s ../../dist,../../assets/images,../../assets/icons,../../assets/videos -o .out",
+    "storybook-deploy": "storybook-to-ghpages -o .out",
+    "test": "jest --coverage  --config ./config/jest.config.js",
+    "twatch": "jest --no-coverage --watch --verbose"
+  },
+  "dependencies": {
+    "@babel/core": "^7.24.0",
+    "@babel/eslint-parser": "^7.23.10",
+    "@emulsify/cli": "^1.6.0",
+    "@storybook/addon-a11y": "^7.6.17",
+    "@storybook/addon-actions": "^7.6.17",
+    "@storybook/addon-essentials": "^7.6.17",
+    "@storybook/addon-links": "^7.6.17",
+    "@storybook/addon-styling-webpack": "^1.0.0",
+    "@storybook/addon-themes": "^7.6.17",
+    "@storybook/html": "^7.6.17",
+    "@storybook/html-webpack5": "^7.6.17",
+    "add-attributes-twig-extension": "^0.1.0",
+    "autoprefixer": "^10.4.19",
+    "babel-loader": "^9.1.3",
+    "babel-preset-minify": "^0.5.2",
+    "bem-twig-extension": "^0.1.1",
+    "breakpoint-sass": "^3.0.0",
+    "chalk": "^5.2.0",
+    "clean-webpack-plugin": "^4.0.0",
+    "concurrently": "^8.2.2",
+    "css-loader": "^7.1.1",
+    "eslint": "^8.57.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-jest": "^27.9.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-security": "^2.1.1",
+    "eslint-plugin-storybook": "^0.8.0",
+    "eslint-webpack-plugin": "^4.1.0",
+    "file-loader": "^6.2.0",
+    "fs-extra": "^11.2.0",
+    "glob": "^10.3.12",
+    "graceful-fs": "^4.2.11",
+    "html-webpack-plugin": "^5.6.0",
+    "imagemin-webpack-plugin": "^2.4.2",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "js-yaml": "^4.1.0",
+    "js-yaml-loader": "^1.2.2",
+    "lint-staged": "^15.2.2",
+    "mini-css-extract-plugin": "^2.9.0",
+    "node-sass-glob-importer": "^5.3.3",
+    "normalize.css": "^8.0.1",
+    "open-cli": "^8.0.0",
+    "pa11y": "^7.0.0",
+    "postcss": "^8.4.38",
+    "postcss-loader": "^8.1.1",
+    "postcss-scss": "^4.0.9",
+    "ramda": "^0.29.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "regenerator-runtime": "^0.14.1",
+    "sass": "^1.75.0",
+    "sass-loader": "^14.2.1",
+    "storybook": "^7.6.17",
+    "style-dictionary": "^3.9.2",
+    "stylelint": "^16.3.1",
+    "stylelint-config-standard-scss": "^13.1.0",
+    "stylelint-prettier": "^5.0.0",
+    "stylelint-selector-bem-pattern": "^4.0.0",
+    "stylelint-webpack-plugin": "^5.0.0",
+    "svg-sprite-loader": "^6.0.11",
+    "token-transformer": "^0.0.33",
+    "twig-drupal-filters": "^3.2.0",
+    "twig-loader": "github:fourkitchens/twig-loader",
+    "twig-testing-library": "^1.2.0",
+    "webpack": "^5.91.0",
+    "webpack-cli": "^5.1.4",
+    "webpack-merge": "^5.10.0",
+    "yaml": "^2.4.1"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.2.0",
+    "@commitlint/config-conventional": "^19.1.0",
+    "@semantic-release/changelog": "^6.0.2",
+    "@semantic-release/commit-analyzer": "^11.1.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^10.0.2",
+    "@semantic-release/release-notes-generator": "^12.1.0",
+    "husky": "^9.0.11",
+    "semantic-release": "^23.0.4"
+  },
+  "overrides": {
+    "graceful-fs": "^4.2.11"
+  }
+}