@openstax/ts-utils 1.33.1 → 1.34.0

package/.cfnlintrc

@@ -0,0 +1,2 @@
+templates:
+  - deploy/*.cfn.yml

package/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @openstax/disco-devs

package/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on: [pull_request]
+
+jobs:
+  linked_issue:
+    name: Jira
+    runs-on: ubuntu-latest
+    steps:
+    - uses: openstax/jira-linked-action@v0.1.14
+      with:
+        jira_site: openstax
+        jira_project: DISCO
+        jira_email: ${{ secrets.JiraEmail }}
+        jira_token: ${{ secrets.JiraToken }}
+  test:
+    name: checks
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        module: [lambda, frontend, utils]
+    env:
+      CI: true
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
+    - uses: actions/setup-node@v3
+      with:
+        node-version-file: .nvmrc
+        cache: yarn
+    - run: yarn install --immutable
+    - run: yarn build
+    - run: yarn ci
+      working-directory: packages/${{ matrix.module }}

package/.github/workflows/lint.yml

@@ -0,0 +1,55 @@
+name: Lint
+
+on: [pull_request]
+
+jobs:
+  cfn:
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+
+      - name: Run pip install
+        run: pip install cfn-lint
+
+      - name: Run cfn-lint
+        run: cfn-lint
+  spelling:
+    name: spelling
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
+    - uses: actions/setup-node@v3
+      with:
+        node-version-file: .nvmrc
+        cache: yarn
+    - run: yarn install --immutable
+    - run: yarn ci:spelling
+  syncpack:
+    name: versions
+    runs-on: ubuntu-latest
+    env:
+      CI: true
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.event.pull_request.head.sha }}
+    - uses: actions/setup-node@v3
+      with:
+        node-version-file: .nvmrc
+        cache: yarn
+    - run: yarn install --immutable
+    - run: yarn ci:versions

package/.nvmrc

@@ -0,0 +1 @@
+v22.16.0

package/.syncignore

@@ -0,0 +1,4 @@
+README.md
+docs/*
+example/*
+packages/utils/*

package/.syncpackrc

@@ -0,0 +1,18 @@
+{
+  "semverGroups": [
+    {
+      "label": "use exact versions",
+      "packages": ["**"],
+      "dependencyTypes": ["**"],
+      "dependencies": ["@openstax/ts-utils", "typescript", "react-scripts", "@project/*", "@openstax/ui-components"],
+      "range": ""
+    },
+    {
+      "label": "use caret ranges",
+      "packages": ["**"],
+      "dependencyTypes": ["prod"],
+      "dependencies": ["**"],
+      "range": "^"
+    }
+  ]
+}

package/CONTRIBUTING.md

@@ -0,0 +1,96 @@
+<!-- spell-checker: ignore tada Connexions HOTFIXES -->
+# Contributing to Openstax
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+The following is a set of guidelines for contributing to the Openstax repositories, which are hosted in the [Openstax Organization](https://github.com/openstax) and [Connexions Organization](https://github.com/Connexions) on GitHub.
+These are just guidelines, not rules. Use your best judgment and feel free to propose changes to this document in a pull request.
+
+#### Table of Contents
+
+- [Git Hygiene](#git-hygiene)
+  - [Use a Good Commit Message](#use-a-good-commit-message)
+  - [Squash Commits](#squash-commits)
+  - [Handling Merge Conflicts](#handling-merge-conflicts)
+- [Testing](#testing)
+  - [JavaScript](#javascript)
+
+# Git Hygiene
+
+Some guidelines for keeping your code in shape
+
+
+## Use a Good Commit Message
+
+[Use a good commit message](https://github.com/spring-projects/spring-framework/blob/30bce7/CONTRIBUTING.md#format-commit-messages)
+
+
+## Squash Commits
+
+The project doesn't need a record of you fixing whitespace and spelling mistakes in your PR. As a general rule of thumb, if a commit modifies a previous commit in the same PR, it probably needs to be squashed. That means that a PR may often only be a single commit. This makes rebasing (see below) easier, and keeps the history clean, which can make debugging infinitely easier in the long run.
+
+- It's fine to make as many commits as you need while you're working on your local branch. Keeping your history clean as you work will probably be much easier than trying to do it all at the end, though.
+
+- If you just want to make a change and have it apply to your last commit, you can use `git commit --amend`. If you want a change to be associated with an older commit, you can use `git commit -i HEAD~3` (where `3` is the number of commits to rebase). You can also use `git log` to find a commit's hash and `git rebase -i <commit hash>` (the commit should be the one PRIOR to the commit you want to modify).
+
+- Interactive rebase (`git rebase -i`) will open your default editor in which you can replace `pick` with `fixup` or `f` to combine commits (you can also use this to reorder commits, mark commits to edit their commit messages, and other powerful tools which are explained in the file itself). Save the changes, and git will execute the rebase.
+
+After rebasing, if your branch is already pushed up to GitHub, you'll have to force push the changes using `git push -f`, since the history has changed.
+
+**Warning:** Only rebase your own branches.
+
+**Warning:** **DO NOT REBASE HOTFIXES** Otherwise :bomb: :sparkles:
+
+
+
+## Handling Merge Conflicts
+
+Occasionally a Pull Request will have Merge Conflicts. **Do not merge master into your branch.** Instead, make sure your `master` branch is up to date:
+
+```sh
+git checkout master
+git pull
+```
+
+Then rebase your branch on `master`:
+
+```sh
+git checkout _my-branch_
+git rebase master
+```
+
+If there are any conflicts you need to resolve, it will suspend the rebase for you to fix them. Then do:
+
+```sh
+git add .
+git rebase --continue
+```
+
+It will do one round of conflict-checking for each commit in your branch, so keeping your history clean will make rebasing much easier. When the rebase is done, your branch will be up to date with master and ready to issue a PR if you are.
+
+# Hotfix
+To make a fix against production, first find the revision.  For example
+for tutor, you can find the revisions here: http://tutor.openstax.org/rev.txt
+
+Once you have the revision commit sha, you can do the following:
+```sh
+git branch <branch-name> <revision-sha>
+git checkout <branch-name>
+```
+
+After adding in your fixes, just push your branch up using:
+```sh
+git push origin <branch-name>
+```
+
+Since we don't keep a production branch, you can just make a PR against master and then you're done!
+
+# Testing
+
+This section contains testing practices for the various languages used in openstax
+
+## JavaScript
+
+Use the diagnostics from `npm test` (tests are also run as part of `npm start` and any changes to a file are also tested if `npm start` is currently running). 
+It's much easier to stay on top of issues as you make changes than trying to fix everything later. 
+If you have `npm start` running, it can also sometimes be useful to run `npm test` in a separate process, which will analyze every file, and is the same tests that Travis CI runs on commits and PRs.