build(root): Initial project scaffolding #2

mohanraj-r · 2020-03-13T00:58:20Z

Setup initial scaffolding for monorepo with required dev deps (based on lwc projects). This PR should be merged before others.

add single quote pref to editor config

from https://github.com/salesforce/oss-template

mohanraj-r · 2020-03-17T22:34:35Z

@salesforce/sa11y-reviewers Can you give a quick review and merge this please. This PR does not contain any code changes. It is initial setup and config (mostly inspired from Salesforce, LWC projects) that is in its own PR to help make the changes in subsequent PRs easier to review.

# Conflicts: # yarn.lock

trevor-bliss · 2020-03-17T23:43:41Z

@mohanraj-r Will take a look at this soon.

trevor-bliss · 2020-03-18T00:12:00Z

.npmrc

@@ -0,0 +1,2 @@
+@types:registry=https://registry.npmjs.org/
+registry=https://registry.npmjs.org/


Do you need to set these? They should be the defaults.

Since I have the internal nexus registry configured in the global .npmrc, it was resulting in refs to the internal nexus in the yarn.lock file. Hence had to override it to make sure there are no refs to internal registry - which could affect the CI among others. I guess most projects override the publish config in package.json to the public npm?

I agree the references should point to the pubic registry rather than internal Nexus for this project. From an open source point of view I don't think there should be any references to the public registry though. I personally comment out the line pointing to Nexus in my root npmrc and only uncomment it when I need to access internal stuff.

Since it's probably a ways away from being truly open source it's probably fine to leave for now, but I think it should be removed by the time it's exposed externally.

Looks like we can also switch npm registries using profiles https://docs.npmjs.com/configuring-your-registry-settings-as-an-npm-enterprise-user#create-a-profile-for-the-public-npm-registry
But then this adds a manual step to the process which could be easily forgotten.
Agree that we can revisit this later again when we are ready to make this public.

trevor-bliss · 2020-03-18T00:15:54Z

Readme.md

@@ -0,0 +1,24 @@
+# Salesforce Accessibility Automation Libraries


Nit: this file name is usually all caps (README.md)

trevor-bliss · 2020-03-18T00:25:42Z

commitlint.config.js

+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+module.exports = {
+    extends: ['@commitlint/config-conventional'],


I personally find that linting commits like this can be confusing for people who don't use it frequently. I've also seen people be confused by what exactly the issue is with their commit title/message.

Nothing wrong with keeping this if you like it, but if you do I would make sure when there's an error it's clear what's wrong. LWC has a section in the CONTRIBUTING.md that details their specific commit rules.

Good to know thanks. Added contribution guidelines to this project as well based on lwc.
Besides from uniformity in commit msgs, the main benefit I am hoping for is in auto-generating changelog. Other than that I am not sure I see a clear benefit for now.

Btw I am also going to try limiting to squashing commits when merging to master - to have a saner commit history (since I tend to create a lot of granular commits). So this should result in one commit per PR in master in which case the commit linting is rendered moot I guess. If this could be problematic or not ideal, please let me know.

trevor-bliss · 2020-03-18T00:32:10Z

jest.config.js

+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+module.exports = {
+    preset: 'ts-jest',


With Jest 24 there's much better support for Typescript: https://jestjs.io/blog/2019/01/25/jest-24-refreshing-polished-typescript-friendly#typescript-support.

The maintainer of ts-jest has basically said to just use native Jest: kulshekhar/ts-jest#961 (comment)

I wouldn't say this is a must-have, but worth considering for the future since other projects have reported a speed improvement moving away from ts-jest.

I saw references to using babel for compiling ts. But then I also saw https://kulshekhar.github.io/ts-jest/user/babel7-or-ts which lists some features not available in babel yet. Not sure if that info is current. And since this project doesn't use babel yet - I didn't want to bring it in as a dependency yet. Not sure if we will need babel for any other purpose?

I don't know if you'll need Babel for other stuff. FWIW Babel is a dependency of Jest so you technically are already pulling it in to the project as a transitive dependency.

I think using babel + Jest is the best thing to do but I don't think it will be particularly hard to make that switch in the future so if you want to stick with this for now and re-evaluate later when you have more tests that's fine.

Thanks Trevor. Didn't know that babel is already a Jest dependency. Tried replacing ts-jest with babel/preset-typescript as per https://jestjs.io/docs/en/getting-started. Ran into some errors with jest trying to run the .js files as well as .d.ts files in addition to .ts files. Probably needs more config than what is mentioned in those docs. Also with the caveats https://babeljs.io/docs/en/next/babel-plugin-transform-typescript.html#caveats tempted to give this a try again a little later.

trevor-bliss · 2020-03-18T00:35:42Z

packages/rules/.github/workflows/ci.yml

+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v1
+              with:
+                  node-version: '10.x'


Active LTS support for Node 10 ends the end of April. Version 12 is active LTS until the end of October, it may be worth switching to 12 now.

https://nodejs.org/en/about/releases/

Great, thanks for the info! Updated.

trevor-bliss · 2020-03-18T00:37:12Z

packages/rules/.github/workflows/ci.yml

+              with:
+                  node-version: '10.x'
+            - run: yarn install
+            - run: yarn test


Add a linting job here before unit tests?

- run: yarn lint

Yes! Had it in the #3 PR - ported it over. Made a yarn ci target so as to make it easier to manage.

trevor-bliss · 2020-03-18T00:43:52Z

packages/rules/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@sa11y/rules",
+  "version": "1.0.0",


I would default versions to 0.1.0. Having the major version set signals that the API is set. Having the major version at 0 signals it's still under active development and things can change at any time.

Good point, updated!

trevor-bliss · 2020-03-18T00:45:19Z

@mohanraj-r Left a few comments. I don't think anything is a blocker so if you want feel free to merge now. Otherwise I can re-review after you make changes.

mohanraj-r

Thanks very much for the review @trevor-bliss
Have made changes and comments. Please review.

mohanraj-r · 2020-03-18T01:34:06Z

.npmrc

@@ -0,0 +1,2 @@
+@types:registry=https://registry.npmjs.org/
+registry=https://registry.npmjs.org/


Since I have the internal nexus registry configured in the global .npmrc, it was resulting in refs to the internal nexus in the yarn.lock file. Hence had to override it to make sure there are no refs to internal registry - which could affect the CI among others. I guess most projects override the publish config in package.json to the public npm?

mohanraj-r · 2020-03-18T01:44:07Z

Readme.md

@@ -0,0 +1,24 @@
+# Salesforce Accessibility Automation Libraries


mohanraj-r · 2020-03-18T01:55:16Z

commitlint.config.js

+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+module.exports = {
+    extends: ['@commitlint/config-conventional'],


Good to know thanks. Added contribution guidelines to this project as well based on lwc.
Besides from uniformity in commit msgs, the main benefit I am hoping for is in auto-generating changelog. Other than that I am not sure I see a clear benefit for now.

mohanraj-r · 2020-03-18T02:07:21Z

jest.config.js

+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+module.exports = {
+    preset: 'ts-jest',


I saw references to using babel for compiling ts. But then I also saw https://kulshekhar.github.io/ts-jest/user/babel7-or-ts which lists some features not available in babel yet. Not sure if that info is current. And since this project doesn't use babel yet - I didn't want to bring it in as a dependency yet. Not sure if we will need babel for any other purpose?

mohanraj-r · 2020-03-18T02:22:07Z

packages/rules/.github/workflows/ci.yml

+            - uses: actions/checkout@v2
+            - uses: actions/setup-node@v1
+              with:
+                  node-version: '10.x'


Great, thanks for the info! Updated.

mohanraj-r · 2020-03-18T02:29:00Z

packages/rules/.github/workflows/ci.yml

+              with:
+                  node-version: '10.x'
+            - run: yarn install
+            - run: yarn test


Yes! Had it in the #3 PR - ported it over. Made a yarn ci target so as to make it easier to manage.

mohanraj-r · 2020-03-18T02:29:40Z

packages/rules/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@sa11y/rules",
+  "version": "1.0.0",


Good point, updated!

mohanraj-r

Thanks for the review and approval @trevor-bliss
Looks like I can't merge it myself - seeing "Merging is blocked" on my side. Probably because of a github protected branch config limiting authors from merging - not sure. Can you please merge it if you can.

mohanraj-r · 2020-03-18T19:13:34Z

.npmrc

@@ -0,0 +1,2 @@
+@types:registry=https://registry.npmjs.org/
+registry=https://registry.npmjs.org/


Looks like we can also switch npm registries using profiles https://docs.npmjs.com/configuring-your-registry-settings-as-an-npm-enterprise-user#create-a-profile-for-the-public-npm-registry
But then this adds a manual step to the process which could be easily forgotten.
Agree that we can revisit this later again when we are ready to make this public.

mohanraj-r · 2020-03-18T19:16:16Z

commitlint.config.js

+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+module.exports = {
+    extends: ['@commitlint/config-conventional'],


Btw I am also going to try limiting to squashing commits when merging to master - to have a saner commit history (since I tend to create a lot of granular commits). So this should result in one commit per PR in master in which case the commit linting is rendered moot I guess. If this could be problematic or not ideal, please let me know.

mohanraj-r · 2020-03-18T19:53:30Z

jest.config.js

+ * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+module.exports = {
+    preset: 'ts-jest',


Thanks Trevor. Didn't know that babel is already a Jest dependency. Tried replacing ts-jest with babel/preset-typescript as per https://jestjs.io/docs/en/getting-started. Ran into some errors with jest trying to run the .js files as well as .d.ts files in addition to .ts files. Probably needs more config than what is mentioned in those docs. Also with the caveats https://babeljs.io/docs/en/next/babel-plugin-transform-typescript.html#caveats tempted to give this a try again a little later.

trevor-bliss · 2020-03-18T21:03:17Z

Yes, merging is blocked because of the protected branch settings in the repo. I cannot merge either. I also see this error here: "At least 1 approving review is required by reviewers with write access". I see in the sa11y-reviewers group I'm a part of, I have "Triage" permissions, but the branch protection rules require someone with write access to approve.

If you're a maintainer/admin of this repo I recommend going to the Settings on the repo home page and either loosening the branch protection rules so you can still merge, or giving me write permissions to satisfy the branch protections.

mohanraj-r · 2020-03-18T21:21:12Z

Thanks @trevor-bliss - Changed sa11y-reviewers to have write perms. When I saw that "Triage" said "Can also manage issues and pull requests" I thought that would include merging pull requests. Sorry for the confusion.

mohanraj-r · 2020-03-19T03:23:19Z

@trevor-bliss Not sure if we need to "Require signed commits" for an OSS project? Have to figure out how to do that for multiple github accounts - not able to find a way similar to using multiple ssh keys.

trevor-bliss · 2020-03-19T18:19:18Z

@mohanraj-r Looks like commit signing was turned off. I think this is good to merge now. Feel free to merge whenever you're ready.

mohanraj-r · 2020-03-20T00:00:02Z

Thanks for the review and approvals @trevor-bliss @cordeliadillon . Merged.
Sounds like there is no clear need to "Require signed commits" for an OSS project - so going to leave it disabled for now. Let me know if this needs to change.

Mohan Raj Rajamanickam added 17 commits March 12, 2020 14:49

chore: lerna init

05d6752

chore: typescript init

f623fb3

chore: set yarn as npm client for lerna

163a05b

chore: add dev deps typescript, jest

f7baef3

chore: add editor config

8cde185

chore: add git ignore

5baf5fb

chore: add typescript config with minimal overrides

c412301

chore: add dev dep eslint typescript plugin with minimal eslint config

85ac589

chore: add dev dep jest eslint plugin

343ca82

chore: add prettier eslint plugins, config

08f0a43

add single quote pref to editor config

chore: add scaffolding for ruleset package

1d7b7ea

chore: add yarn lock file

8a0ad5a

doc: Add readme with high-level outline of packages

df24f10

doc: Add license, code of conduct

5a080b8

from https://github.com/salesforce/oss-template

doc: add eslint plugin to check/fix copyright header

9ffae41

chore: update prettier config to sync with editorconfig

03ed0de

build: add deps, config to lint git commits

d3db063

mohanraj-r mentioned this pull request Mar 13, 2020

feature(ruleset): add recommended, extended rulesets #3

Merged

mohanraj-r requested review from trevor-bliss and cordeliadillon March 13, 2020 02:57

Mohan Raj Rajamanickam added 3 commits March 13, 2020 14:30

ci(root): add ci workflow based on github actions

4a183fa

build(root): add deps, config for typescript jest integration

1bc9a35

build(root): mark generated files for github

303b9c2

mohanraj-r requested review from spelak-salesforce and a team March 16, 2020 19:08

build(root): add explicit public npm registry to override internal

f866783

# Conflicts: # yarn.lock

trevor-bliss reviewed Mar 18, 2020

View reviewed changes

Mohan Raj Rajamanickam added 4 commits March 17, 2020 18:43

doc(root): rename readme, white-space reformat, add TBD status

3fdfb3b

build(root): add ci,changelog,build npm scripts;switch to npm@12 for ci

61a5d12

build(root): add node engines, update version of package, set exact

f390e1a

docs(root): add contribution guide

9ca1584

mohanraj-r commented Mar 18, 2020

View reviewed changes

trevor-bliss approved these changes Mar 18, 2020

View reviewed changes

mohanraj-r commented Mar 18, 2020

View reviewed changes

mohanraj-r mentioned this pull request Mar 18, 2020

Migrate from ts-jest to babel typescript transformer #4

Closed

cordeliadillon approved these changes Mar 19, 2020

View reviewed changes

mohanraj-r merged commit 6613355 into master Mar 19, 2020

mohanraj-r deleted the build/initial_scaffolding branch March 19, 2020 23:51

		@@ -0,0 +1,2 @@
		@types:registry=https://registry.npmjs.org/
		registry=https://registry.npmjs.org/

		@@ -0,0 +1,24 @@
		# Salesforce Accessibility Automation Libraries

build(root): Initial project scaffolding #2

build(root): Initial project scaffolding #2

Conversation

mohanraj-r commented Mar 13, 2020 • edited Loading

mohanraj-r commented Mar 17, 2020

trevor-bliss commented Mar 17, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mohanraj-r Mar 18, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

trevor-bliss commented Mar 18, 2020

mohanraj-r left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mohanraj-r left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mohanraj-r Mar 18, 2020 • edited Loading

Choose a reason for hiding this comment

trevor-bliss commented Mar 18, 2020

mohanraj-r commented Mar 18, 2020

mohanraj-r commented Mar 19, 2020

trevor-bliss commented Mar 19, 2020

mohanraj-r commented Mar 20, 2020

mohanraj-r commented Mar 13, 2020 •

edited

Loading

mohanraj-r Mar 18, 2020 •

edited

Loading

mohanraj-r Mar 18, 2020 •

edited

Loading