@jahia/create-module 0.0.9 → 0.5.3

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Jahia Forge - Code Repository
+Copyright (c) 2025 Jahia Forge - Code Repository
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,12 +1,13 @@
-# NPM Module template create-module project
+# Javascript Module template create-module project
 
-This project provides an NPM/NPX starter project template to quickly get up and running to create Jahia NPM modules
+This project provides a Javascript module starter project template to quickly get up and running to create Jahia Javascript modules
 
 ## Usage
 
     npx @jahia/create-module@latest project-name [module-type] [namespace-definitions]
 
-where 
+where
+
 - `project-name` (mandatory) can be anything you want to call your project
 - `module-type` (optional) Can be one of:
   - `templatesSet`: A collection of templates and components. A template set is required when creating a website.

package/babel.config.cjs

@@ -1,6 +1,3 @@
 module.exports = {
-    presets: [
-        '@babel/preset-env',
-        '@babel/preset-react'
-    ]
-};
+  presets: ["@babel/preset-env", "@babel/preset-react"],
+};

package/index.js

@@ -2,22 +2,26 @@
 
 // Usage: npx @jahia/create-module@latest module-name [namespace]
 
-import fs from 'fs';
-import path from 'path';
-import {fileURLToPath} from 'url';
-import {replaceInFileSync} from 'replace-in-file';
-import camelCase from 'camelcase';
-import {execSync} from 'child_process';
+import fs from "fs";
+import path from "path";
+import { fileURLToPath } from "url";
+import { replaceInFileSync } from "replace-in-file";
+import camelCase from "camelcase";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 
-// Show help if no argment is provided
-// eslint-disable-next-line no-unused-vars
-const [nodeCommand, npxCommand, projectName, moduleType = 'module', namespace = camelCase(projectName || '')] = process.argv;
+// Show help if no argument is provided
+const [
+  ,
+  ,
+  projectName,
+  moduleType = "module",
+  namespace = camelCase(projectName || ""),
+] = process.argv;
 
 if (!projectName) {
-    console.log(`\x1B[1m## Usage\x1B[0m
+  console.log(`\x1B[1m## Usage\x1B[0m
 
     npx @jahia/create-module@latest project-name [module-type] [namespace-definitions]
 
@@ -29,32 +33,32 @@ where
   - \x1B[3msystem\x1B[0m Critical module for the whole platform . 
 - \x1B[1mnamespace-definitions\x1B[0m (optional) The namespace used for content definitions. Default is the project name in camel case.
 `);
-    process.exit(9);
+  process.exit(9);
 }
 
 // First let's do some version checks
-console.log('Node version detected:', process.versions.node);
-const yarnVersion = execSync('yarn --version', {encoding: 'utf8'});
-console.log('Yarn version:', yarnVersion);
+console.log("Node version detected:", process.versions.node);
 
 // Create a project directory with the project name.
 const currentDir = process.cwd();
 const projectDir = path.resolve(currentDir, projectName);
-fs.mkdirSync(projectDir, {recursive: true});
+fs.mkdirSync(projectDir, { recursive: true });
 
-console.log(`Creating a new Jahia module project \x1B[1m${projectName}\x1B[0m of type \x1B[1m${moduleType}\x1B[0m and definitions namespace \x1B[1m${namespace}\x1B[0m`);
+console.log(
+  `Creating a new Jahia module project \x1B[1m${projectName}\x1B[0m of type \x1B[1m${moduleType}\x1B[0m and definitions namespace \x1B[1m${namespace}\x1B[0m`,
+);
 
 // A common approach to building a starter template is to
 // create a `template` folder which will house the template
 // and the files we want to create.
-const templateDir = path.resolve(__dirname, 'template');
-const isTemplatesSet = moduleType === 'templatesSet';
+const templateDir = path.resolve(__dirname, "template");
+const isTemplatesSet = moduleType === "templatesSet";
 fs.cpSync(templateDir, projectDir, {
-    recursive: true,
-    filter: src => {
-        // The file template-thumbnail.png is only used for the type templatesSet
-        return (isTemplatesSet || src !== path.join(templateDir, 'settings', 'template-thumbnail.png'));
-    }
+  recursive: true,
+  filter: (src) => {
+    // The file template-thumbnail.png is only used for the type templatesSet
+    return isTemplatesSet || src !== path.join(templateDir, "settings", "template-thumbnail.png");
+  },
 });
 
 // Find and replace all markers with the appropriate substitution values
@@ -62,25 +66,25 @@ fs.cpSync(templateDir, projectDir, {
 const targetFiles = `${projectDir}/**`;
 
 try {
-    replaceInFileSync({
-        files: targetFiles,
-        from: /\$\$MODULE_TYPE\$\$/g,
-        to: moduleType
-    });
-
-    replaceInFileSync({
-        files: targetFiles,
-        from: /\$\$MODULE_NAME\$\$/g,
-        to: projectName
-    });
-
-    replaceInFileSync({
-        files: targetFiles,
-        from: /\$\$MODULE_NAMESPACE\$\$/g,
-        to: namespace
-    });
+  replaceInFileSync({
+    files: targetFiles,
+    from: /\$\$MODULE_TYPE\$\$/g,
+    to: moduleType,
+  });
+
+  replaceInFileSync({
+    files: targetFiles,
+    from: /\$\$MODULE_NAME\$\$/g,
+    to: projectName,
+  });
+
+  replaceInFileSync({
+    files: targetFiles,
+    from: /\$\$MODULE_NAMESPACE\$\$/g,
+    to: namespace,
+  });
 } catch (error) {
-    console.error('Error occurred:', error);
+  console.error("Error occurred:", error);
 }
 
 // It is good practice to have dotfiles stored in the
@@ -88,63 +92,67 @@ try {
 // up by the starter template repository). We can rename
 // the dotfiles after we have copied them over to the
 // new project directory.
-fs.renameSync(
-    path.join(projectDir, 'dotgitignore'),
-    path.join(projectDir, '.gitignore')
-);
-fs.renameSync(
-    path.join(projectDir, 'dotnpmignore'),
-    path.join(projectDir, '.npmignore')
-);
-fs.renameSync(
-    path.join(projectDir, 'dotenv'),
-    path.join(projectDir, '.env')
-);
-fs.renameSync(
-    path.join(projectDir, 'doteslintrc.cjs'),
-    path.join(projectDir, '.eslintrc.cjs')
-);
+fs.renameSync(path.join(projectDir, "dotenv"), path.join(projectDir, ".env"));
+fs.renameSync(path.join(projectDir, "dotgitignore"), path.join(projectDir, ".gitignore"));
+fs.renameSync(path.join(projectDir, "dotprettierignore"), path.join(projectDir, ".prettierignore"));
+fs.renameSync(path.join(projectDir, "dotyarnrc.yml"), path.join(projectDir, ".yarnrc.yml"));
+fs.renameSync(path.join(projectDir, "dotgithub"), path.join(projectDir, ".github"));
+fs.renameSync(path.join(projectDir, "dotidea"), path.join(projectDir, ".idea"));
+fs.renameSync(path.join(projectDir, "dotvscode"), path.join(projectDir, ".vscode"));
 
 // Rename the resource file to use the project name
 fs.renameSync(
-    path.join(projectDir, 'settings', 'resources', 'MODULE_NAME.properties'),
-    path.join(projectDir, 'settings', 'resources', projectName + '.properties')
+  path.join(projectDir, "settings", "resources", "MODULE_NAME.properties"),
+  path.join(projectDir, "settings", "resources", projectName + ".properties"),
 );
 
 fs.renameSync(
-    path.join(projectDir, 'settings', 'resources', 'MODULE_NAME_fr.properties'),
-    path.join(projectDir, 'settings', 'resources', projectName + '_fr.properties')
+  path.join(projectDir, "settings", "resources", "MODULE_NAME_fr.properties"),
+  path.join(projectDir, "settings", "resources", projectName + "_fr.properties"),
 );
 
 fs.renameSync(
-    path.join(projectDir, 'settings', 'content-types-icons', 'MODULE_NAMESPACE_simpleContent.png'),
-    path.join(projectDir, 'settings', 'content-types-icons', namespace + '_simpleContent.png')
+  path.join(projectDir, "settings", "content-types-icons", "MODULE_NAMESPACE_simpleContent.png"),
+  path.join(projectDir, "settings", "content-types-icons", namespace + "_simpleContent.png"),
 );
 
 // Create empty directories for static resources and configurations
-fs.mkdirSync(path.join(projectDir, 'static', 'css'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'static', 'images'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'static', 'javascript'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'settings', 'configurations'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'settings', 'content-editor-forms'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'settings', 'content-editor-forms', 'forms'), {recursive: true});
-fs.mkdirSync(path.join(projectDir, 'settings', 'content-editor-forms', 'fieldsets'), {recursive: true});
-
-// Add the latest @jahia/javascript-modules-library
-execSync('yarn add @jahia/javascript-modules-library', {cwd: projectDir});
-const javascriptModulesLibraryInfo = execSync('yarn info @jahia/javascript-modules-library version --json', {cwd: projectDir, encoding: 'utf8'});
-const javascriptModulesLibraryInfoValue = JSON.parse(javascriptModulesLibraryInfo).value;
-console.log(`Added ${javascriptModulesLibraryInfoValue} to the project`);
+fs.mkdirSync(path.join(projectDir, "static", "css"), { recursive: true });
+fs.mkdirSync(path.join(projectDir, "static", "images"), { recursive: true });
+fs.mkdirSync(path.join(projectDir, "static", "javascript"), { recursive: true });
+fs.mkdirSync(path.join(projectDir, "settings", "configurations"), { recursive: true });
+fs.mkdirSync(path.join(projectDir, "settings", "content-editor-forms"), { recursive: true });
+fs.mkdirSync(path.join(projectDir, "settings", "content-editor-forms", "forms"), {
+  recursive: true,
+});
+fs.mkdirSync(path.join(projectDir, "settings", "content-editor-forms", "fieldsets"), {
+  recursive: true,
+});
+
+// Add an empty yarn.lock in case any parent folder is using yarn
+fs.writeFileSync(path.join(projectDir, "yarn.lock"), "", "utf8");
 
 console.log(`Created \x1B[1m${projectName}\x1B[0m at \x1B[1m${projectDir}\x1B[0m`);
-console.log('Success! Your new project is ready.');
-console.log('You can now change into your project and launch "yarn" to install everything to get started.');
-console.log('---');
-console.log('Available project scripts will then be :');
-console.log('  - yarn build : build the project');
-console.log('  - yarn deploy : deploy the project. Make sure you have updated the .env file to match your setup if needed.');
-console.log('  - yarn watch : will build and watch for file modifications, and deploy automatically when changes are detected. Use CTRL+C to stop watching.');
-console.log('  - yarn lint : use to check that your code follows the recommended syntax guidelines. Append --fix to automatically fix most problems.');
-console.log('  - yarn test : to test your project. By default only performs yarn lint but you are encouraged to add your own testing system here.');
-console.log('---');
-console.log('You can also check the documentation available here for more details: https://academy.jahia.com/get-started/developers/templating');
+console.log("Success! Your new project is ready.");
+console.log(
+  'You can now change into your project and launch "yarn" to install everything to get started.',
+);
+console.log("---");
+console.log("Available project scripts will then be :");
+console.log("  - yarn build : build the project");
+console.log(
+  "  - yarn deploy : deploy the project. Make sure you have updated the .env file to match your setup if needed.",
+);
+console.log(
+  "  - yarn watch : will build and watch for file modifications, and deploy automatically when changes are detected. Use CTRL+C to stop watching.",
+);
+console.log(
+  "  - yarn lint : use to check that your code follows the recommended syntax guidelines. Append --fix to automatically fix most problems.",
+);
+console.log(
+  "  - yarn test : to test your project. By default only performs yarn lint but you are encouraged to add your own testing system here.",
+);
+console.log("---");
+console.log(
+  "You can also check the documentation available here for more details: https://academy.jahia.com/get-started/developers/templating",
+);

package/node/npm

@@ -0,0 +1,65 @@
+#!/usr/bin/env bash
+
+# This is used by the Node.js installer, which expects the cygwin/mingw
+# shell script to already be present in the npm dependency folder.
+
+(set -o igncr) 2>/dev/null && set -o igncr; # cygwin encoding fix
+
+basedir=`dirname "$0"`
+
+case `uname` in
+  *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ `uname` = 'Linux' ] && type wslpath &>/dev/null ; then
+  IS_WSL="true"
+fi
+
+function no_node_dir {
+  # if this didn't work, then everything else below will fail
+  echo "Could not determine Node.js install directory" >&2
+  exit 1
+}
+
+NODE_EXE="$basedir/node.exe"
+if ! [ -x "$NODE_EXE" ]; then
+  NODE_EXE="$basedir/node"
+fi
+if ! [ -x "$NODE_EXE" ]; then
+  NODE_EXE=node
+fi
+
+# this path is passed to node.exe, so it needs to match whatever
+# kind of paths Node.js thinks it's using, typically win32 paths.
+CLI_BASEDIR="$("$NODE_EXE" -p 'require("path").dirname(process.execPath)' 2> /dev/null)"
+if [ $? -ne 0 ]; then
+  # this fails under WSL 1 so add an additional message. we also suppress stderr above
+  # because the actual error raised is not helpful. in WSL 1 node.exe cannot handle
+  # output redirection properly. See https://github.com/microsoft/WSL/issues/2370
+  if [ "$IS_WSL" == "true" ]; then
+    echo "WSL 1 is not supported. Please upgrade to WSL 2 or above." >&2
+  fi
+  no_node_dir
+fi
+NPM_PREFIX_JS="$CLI_BASEDIR/node_modules/npm/bin/npm-prefix.js"
+NPM_CLI_JS="$CLI_BASEDIR/node_modules/npm/bin/npm-cli.js"
+NPM_PREFIX=`"$NODE_EXE" "$NPM_PREFIX_JS"`
+if [ $? -ne 0 ]; then
+  no_node_dir
+fi
+NPM_PREFIX_NPM_CLI_JS="$NPM_PREFIX/node_modules/npm/bin/npm-cli.js"
+
+# a path that will fail -f test on any posix bash
+NPM_WSL_PATH="/.."
+
+# WSL can run Windows binaries, so we have to give it the win32 path
+# however, WSL bash tests against posix paths, so we need to construct that
+# to know if npm is installed globally.
+if [ "$IS_WSL" == "true" ]; then
+  NPM_WSL_PATH=`wslpath "$NPM_PREFIX_NPM_CLI_JS"`
+fi
+if [ -f "$NPM_PREFIX_NPM_CLI_JS" ] || [ -f "$NPM_WSL_PATH" ]; then
+  NPM_CLI_JS="$NPM_PREFIX_NPM_CLI_JS"
+fi
+
+"$NODE_EXE" "$NPM_CLI_JS" "$@"

package/node/npm.cmd

@@ -0,0 +1,20 @@
+:: Created by npm, please don't edit manually.
+@ECHO OFF
+
+SETLOCAL
+
+SET "NODE_EXE=%~dp0\node.exe"
+IF NOT EXIST "%NODE_EXE%" (
+  SET "NODE_EXE=node"
+)
+
+SET "NPM_PREFIX_JS=%~dp0\node_modules\npm\bin\npm-prefix.js"
+SET "NPM_CLI_JS=%~dp0\node_modules\npm\bin\npm-cli.js"
+FOR /F "delims=" %%F IN ('CALL "%NODE_EXE%" "%NPM_PREFIX_JS%"') DO (
+  SET "NPM_PREFIX_NPM_CLI_JS=%%F\node_modules\npm\bin\npm-cli.js"
+)
+IF EXIST "%NPM_PREFIX_NPM_CLI_JS%" (
+  SET "NPM_CLI_JS=%NPM_PREFIX_NPM_CLI_JS%"
+)
+
+"%NODE_EXE%" "%NPM_CLI_JS%" %*

package/node/npx

@@ -0,0 +1,65 @@
+#!/usr/bin/env bash
+
+# This is used by the Node.js installer, which expects the cygwin/mingw
+# shell script to already be present in the npm dependency folder.
+
+(set -o igncr) 2>/dev/null && set -o igncr; # cygwin encoding fix
+
+basedir=`dirname "$0"`
+
+case `uname` in
+  *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ `uname` = 'Linux' ] && type wslpath &>/dev/null ; then
+  IS_WSL="true"
+fi
+
+function no_node_dir {
+  # if this didn't work, then everything else below will fail
+  echo "Could not determine Node.js install directory" >&2
+  exit 1
+}
+
+NODE_EXE="$basedir/node.exe"
+if ! [ -x "$NODE_EXE" ]; then
+  NODE_EXE="$basedir/node"
+fi
+if ! [ -x "$NODE_EXE" ]; then
+  NODE_EXE=node
+fi
+
+# this path is passed to node.exe, so it needs to match whatever
+# kind of paths Node.js thinks it's using, typically win32 paths.
+CLI_BASEDIR="$("$NODE_EXE" -p 'require("path").dirname(process.execPath)' 2> /dev/null)"
+if [ $? -ne 0 ]; then
+  # this fails under WSL 1 so add an additional message. we also suppress stderr above
+  # because the actual error raised is not helpful. in WSL 1 node.exe cannot handle
+  # output redirection properly. See https://github.com/microsoft/WSL/issues/2370
+  if [ "$IS_WSL" == "true" ]; then
+    echo "WSL 1 is not supported. Please upgrade to WSL 2 or above." >&2
+  fi
+  no_node_dir
+fi
+NPM_PREFIX_JS="$CLI_BASEDIR/node_modules/npm/bin/npm-prefix.js"
+NPX_CLI_JS="$CLI_BASEDIR/node_modules/npm/bin/npx-cli.js"
+NPM_PREFIX=`"$NODE_EXE" "$NPM_PREFIX_JS"`
+if [ $? -ne 0 ]; then
+  no_node_dir
+fi
+NPM_PREFIX_NPX_CLI_JS="$NPM_PREFIX/node_modules/npm/bin/npx-cli.js"
+
+# a path that will fail -f test on any posix bash
+NPX_WSL_PATH="/.."
+
+# WSL can run Windows binaries, so we have to give it the win32 path
+# however, WSL bash tests against posix paths, so we need to construct that
+# to know if npm is installed globally.
+if [ "$IS_WSL" == "true" ]; then
+  NPX_WSL_PATH=`wslpath "$NPM_PREFIX_NPX_CLI_JS"`
+fi
+if [ -f "$NPM_PREFIX_NPX_CLI_JS" ] || [ -f "$NPX_WSL_PATH" ]; then
+  NPX_CLI_JS="$NPM_PREFIX_NPX_CLI_JS"
+fi
+
+"$NODE_EXE" "$NPX_CLI_JS" "$@"

package/node/npx.cmd

@@ -0,0 +1,20 @@
+:: Created by npm, please don't edit manually.
+@ECHO OFF
+
+SETLOCAL
+
+SET "NODE_EXE=%~dp0\node.exe"
+IF NOT EXIST "%NODE_EXE%" (
+  SET "NODE_EXE=node"
+)
+
+SET "NPM_PREFIX_JS=%~dp0\node_modules\npm\bin\npm-prefix.js"
+SET "NPX_CLI_JS=%~dp0\node_modules\npm\bin\npx-cli.js"
+FOR /F "delims=" %%F IN ('CALL "%NODE_EXE%" "%NPM_PREFIX_JS%"') DO (
+  SET "NPM_PREFIX_NPX_CLI_JS=%%F\node_modules\npm\bin\npx-cli.js"
+)
+IF EXIST "%NPM_PREFIX_NPX_CLI_JS%" (
+  SET "NPX_CLI_JS=%NPM_PREFIX_NPX_CLI_JS%"
+)
+
+"%NODE_EXE%" "%NPX_CLI_JS%" %*

package/node/yarn/dist/LICENSE

@@ -0,0 +1,26 @@
+BSD 2-Clause License
+
+For Yarn software
+
+Copyright (c) 2016-present, Yarn Contributors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+ * Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+ * Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/node/yarn/dist/README.md

@@ -0,0 +1,60 @@
+<p align="center">
+  <a href="https://yarnpkg.com/">
+    <img alt="Yarn" src="https://github.com/yarnpkg/assets/blob/master/yarn-kitten-full.png?raw=true" width="546">
+  </a>
+</p>
+
+<p align="center">
+  Fast, reliable, and secure dependency management.
+</p>
+
+<p align="center">
+  <a href="https://circleci.com/gh/yarnpkg/yarn"><img alt="Circle Status" src="https://circleci.com/gh/yarnpkg/yarn.svg?style=shield&circle-token=5f0a78473b0f440afb218bf2b82323cc6b3cb43f"></a>
+  <a href="https://ci.appveyor.com/project/kittens/yarn/branch/master"><img alt="Appveyor Status" src="https://ci.appveyor.com/api/projects/status/0xdv8chwe2kmk463?svg=true"></a>
+  <a href="https://dev.azure.com/yarnpkg/yarn/_build"><img alt="Azure Pipelines status" src="https://dev.azure.com/yarnpkg/yarn/_apis/build/status/Yarn%20Acceptance%20Tests"></a>
+  <a href="https://discord.gg/yarnpkg"><img alt="Discord Chat" src="https://img.shields.io/discord/226791405589233664.svg"></a>
+  <a href="http://commitizen.github.io/cz-cli/"><img alt="Commitizen friendly" src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg"></a>
+</p>
+
+---
+
+**Fast:** Yarn caches every package it has downloaded, so it never needs to download the same package again. It also does almost everything concurrently to maximize resource utilization. This means even faster installs.
+
+**Reliable:** Using a detailed but concise lockfile format and a deterministic algorithm for install operations, Yarn is able to guarantee that any installation that works on one system will work exactly the same on another system.
+
+**Secure:** Yarn uses checksums to verify the integrity of every installed package before its code is executed.
+
+## Features
+
+* **Offline Mode.** If you've installed a package before, then you can install it again without an internet connection.
+* **Deterministic.** The same dependencies will be installed in the same exact way on any machine, regardless of installation order.
+* **Network Performance.** Yarn efficiently queues requests and avoids request waterfalls in order to maximize network utilization.
+* **Network Resilience.** A single request that fails will not cause the entire installation to fail. Requests are automatically retried upon failure.
+* **Flat Mode.** Yarn resolves mismatched versions of dependencies to a single version to avoid creating duplicates.
+* **More emojis.** 🐈
+
+## Installing Yarn
+
+Read the [Installation Guide](https://yarnpkg.com/en/docs/install) on our website for detailed instructions on how to install Yarn.
+
+## Using Yarn
+
+Read the [Usage Guide](https://yarnpkg.com/en/docs/usage) on our website for detailed instructions on how to use Yarn.
+
+## Contributing to Yarn
+
+Contributions are always welcome, no matter how large or small. Substantial feature requests should be proposed as an [RFC](https://github.com/yarnpkg/rfcs). Before contributing, please read the [code of conduct](CODE_OF_CONDUCT.md).
+
+See [Contributing](https://yarnpkg.com/org/contributing/).
+
+## Prior art
+
+Yarn wouldn't exist if it wasn't for excellent prior art. Yarn has been inspired by the following projects:
+
+ - [Bundler](https://github.com/bundler/bundler)
+ - [Cargo](https://github.com/rust-lang/cargo)
+ - [npm](https://github.com/npm/cli)
+
+## Credits
+
+Thanks to [Sam Holmes](https://github.com/samholmes) for donating the npm package name!

package/node/yarn/dist/bin/yarn

@@ -0,0 +1,35 @@
+#!/bin/sh
+argv0=$(echo "$0" | sed -e 's,\\,/,g')
+basedir=$(dirname "$(readlink "$0" || echo "$argv0")")
+
+case "$(uname -s)" in
+  Darwin) basedir="$( cd "$( dirname "$argv0" )" && pwd )";;
+  Linux) basedir=$(dirname "$(readlink -f "$0" || echo "$argv0")");;
+  *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+  *MSYS*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+command_exists() {
+  command -v "$1" >/dev/null 2>&1;
+}
+
+if command_exists node; then
+  if [ "$YARN_FORCE_WINPTY" = 1 ] || command_exists winpty && test -t 1; then
+    winpty node "$basedir/yarn.js" "$@"
+  else
+    exec node "$basedir/yarn.js" "$@"
+  fi
+  ret=$?
+# Debian and Ubuntu use "nodejs" as the name of the binary, not "node", so we
+# search for that too. See:
+# https://lists.debian.org/debian-devel-announce/2012/07/msg00002.html
+# https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=614907
+elif command_exists nodejs; then
+  exec nodejs "$basedir/yarn.js" "$@"
+  ret=$?
+else
+  >&2 echo 'Yarn requires Node.js 4.0 or higher to be installed.'
+  ret=1
+fi
+
+exit $ret

package/node/yarn/dist/bin/yarn.cmd

@@ -0,0 +1,2 @@
+@echo off
+node "%~dp0\yarn.js" %*

package/node/yarn/dist/bin/yarn.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+
+/* eslint-disable no-var */
+/* eslint-disable flowtype/require-valid-file-annotation */
+'use strict';
+
+var ver = process.versions.node;
+var majorVer = parseInt(ver.split('.')[0], 10);
+
+if (majorVer < 4) {
+  console.error('Node version ' + ver + ' is not supported, please use Node.js 4.0 or higher.');
+  process.exit(1); // eslint-disable-line no-process-exit
+} else {
+  try {
+    require(__dirname + '/../lib/v8-compile-cache.js');
+  } catch (err) {
+    // We don't have/need this on legacy builds and dev builds
+  }
+
+  // Just requiring this package will trigger a yarn run since the
+  // `require.main === module` check inside `cli/index.js` will always
+  // be truthy when built with webpack :(
+  // `lib/cli` may be `lib/cli/index.js` or `lib/cli.js` depending on the build.
+  var cli = require(__dirname + '/../lib/cli');
+  if (!cli.autoRun) {
+    cli.default().catch(function(error) {
+      console.error(error.stack || error.message || error);
+      process.exitCode = 1;
+    });
+  }
+}

package/node/yarn/dist/bin/yarnpkg

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('./yarn.js');

package/node/yarn/dist/bin/yarnpkg.cmd

@@ -0,0 +1,2 @@
+@echo off
+"%~dp0\yarn.cmd" %*