diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bfc2302..1d4b284 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -130,6 +130,19 @@ automatic commit that increments the version numbers. You don't need to commit t 1. Select the new version (or enter a custom one) adhering to the principles of semantic versioning. 1. Lerna will create a new release of the packages that have been updated. It will create a new git commit/tag and publish to npm. +## Developing on Windows + +If you develop on Windows you might run into issues that your Mac/Linux counterparts have never encountered. Here's a suggested setup to combat this: + +1. Git bash (ensure you have included the bash terminal and commands in your system PATHs) +2. nvm for Windows +3. Node 11.11.0 +4. Yarn 1.17.3 + +Getting the node and yarn version correct helps to prevent issues relating to git bash path modification (https://github.com/yarnpkg/yarn/issues/5717) and multiple packages of the same dependency issues with yarn workspaces. + +If you get the issue `Something went wrong installing the 'sharp' module` try doing `npm uninstall expo-cli -g` before running yarn again. (https://github.com/lovell/sharp/issues/1696) + ## License By contributing to Rhythm UI, you agree that your contributions will be licensed under the BSD-3-Clause license. diff --git a/package.json b/package.json index 2d2c7d0..fa8fbfc 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "author": "Deloitte Digital AU", "license": "BSD-3-Clause", "engines": { - "node": ">=10.0.0 <11.0.0" + "node": ">=10.0.0 <12.0.0" }, "workspaces": { "packages": [ @@ -26,18 +26,18 @@ }, "scripts": { "lint": "yarn lint:scripts && yarn lint:css", - "lint:scripts": "yarn eslint --fix \"**/*.{ts,tsx,js,jsx,vue}\"", - "lint:css": "yarn stylelint \"components/**/*.ts\" --config .stylelintrc-ts.js", + "lint:scripts": "eslint --fix \"**/*.{ts,tsx,js,jsx,vue}\"", + "lint:css": "stylelint \"components/**/*.ts\" --config .stylelintrc-ts.js", "bootstrap": "lerna bootstrap", "unstrap": "lerna clean --yes", "clean": "lerna run clean && rimraf .ruidocs", - "test": "RUI_NO_DEFAULT_REGISTER='false' yarn karma start", + "test": "RUI_NO_DEFAULT_REGISTER='false' karma start", "build": "yarn build:site && yarn build:storybook", "build:site": "lerna run build --scope www --include-filtered-dependencies --parallel --stream", "build:vanilla": "lerna run build --stream --scope rhythm-ui --include-filtered-dependencies", - "build:storybook": "yarn lerna run build ---ignore www --ignore rhythm-ui --ignore test && yarn run build:storybook:react", - "build:storybook:react": "yarn lerna run build ---ignore www --ignore rhythm-ui --ignore test && node_modules/@storybook/react/bin/build.js -c adapters/react/.storybook -o .out-react", - "build:storybook:vue": "yarn lerna run build ---ignore www --ignore rhythm-ui --ignore test && node_modules/@storybook/vue/bin/build.js -c adapters/vue/.storybook -o .out-vue", + "build:storybook": "lerna run build ---ignore www --ignore rhythm-ui --ignore test && yarn run build:storybook:react", + "build:storybook:react": "lerna run build ---ignore www --ignore rhythm-ui --ignore test && node_modules/@storybook/react/bin/build.js -c adapters/react/.storybook -o .out-react", + "build:storybook:vue": "lerna run build ---ignore www --ignore rhythm-ui --ignore test && node_modules/@storybook/vue/bin/build.js -c adapters/vue/.storybook -o .out-vue", "start": "lerna run start --scope www --include-filtered-dependencies --parallel --stream", "restart": "lerna run start --scope www --parallel --stream", "start:react": "node_modules/@storybook/react/bin/index.js -p 6006 -c adapters/react/.storybook",