check.sh.md

Author: toptobes

scripts/check.sh

@@ -29,7 +29,7 @@ while [ $# -gt 0 ]; do
  fi
  echo "Usage:"
  echo
- echo "$0 [tc] [lint] [licensing] [lib-check]"
+ echo "$0 [tc] [lint] [licensing] [lib-check] [test-exts] [test-names]"
  echo
  echo "* tc: runs the type-checker"
  echo "* lint: checks for linting errors"

scripts/docs/check.sh.md

@@ -0,0 +1,88 @@
+# `check.sh` (The custom checker script)
+
+A script that checks various aspects of the project to ensure that it is in a good state, including: 
+- Type-checking,
+- Linting
+- Compilation
+- Enforcement of various project conventions.
+
+This script should be run, at the very least, before merging any changes into the main branch or releasing, but ideally,
+much more often than just that.
+
+## Contents
+
+- [Check script usage](#check-script-usage)
+- [Available checks](#available-checks)
+- [See also](#see-also)
+
+## Check script usage
+
+The API for the check script is as follows, where all checks are run by default if no arguments are provided:
+
+```fortran
+scripts/check.sh [tc] [lint] [licensing] [lib-check] [test-exts] [test-names]
+```
+
+One or more of the above checks may be specified otherwise, to run only the specified checks in the order they are provided.
+
+The check script will return a non-zero exit code if any of the checks fail, and will print out the results of each check as it runs.
+
+## Available checks
+
+### Run type-checker (`tc`)
+
+If set, `tsc` will be run with `--noEmit` to ensure that the `src` and `test` folders type-check correctly.
+
+### Run linter (`lint`)
+
+If set, `eslint` will be run over the `src` and `test` folders to ensure that the code follows proper conventions.
+
+### Check licensing headers (`licensing`)
+
+If set, the script will check that all files in the `src` and `test` folders have the correct apache 2.0 licensing headers.
+
+```
+// Copyright DataStax, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+```
+
+### Check library compilation (`lib-check`)
+
+If set, the script will build the library, and set it as the dependency of a newly created TS project with `skipLibCheck: false`
+to ensure that the library compiles correctly, and may be used in other projects without issue.
+
+### Check test extension conventions (`test-exts`)
+
+If set, the script will check that all test files in the `test` folder have the `.test.ts` extension.
+
+### Check test naming conventions (`test-names`)
+
+If set, the script will check that all file-level test suites in the `test` folder have the correct naming convention.
+
+It is expected that each file-level test suite will have a name that matches the file path relative to the `tests/` directory,
+with slashes replaced by dots, and the `.test.ts` extension removed.
+
+For example, the file `tests/unit/documents/cursor.test.ts` should have a file-level test suite named `unit.documents.cursor`.
+
+```ts
+describe('unit.documents.cursor', () => {
+ // Tests here
+});
+```
+
+This works even if the root-level suite is a `parallel` or `background` block.
+
+## See also
+
+- [The custom test script](./test.sh.md)

scripts/docs/startgate.md renamed to scripts/docs/startgate.sh.md

@@ -11,3 +11,7 @@ scripts/startgate.sh
 # Main terminal window after waiting for stargate to start-gate (heh)
 scripts/test.sh -local
 ```
+
+## See also
+
+- [The custom test script](./test.sh.md)

scripts/docs/test.sh.md

@@ -35,6 +35,7 @@ You can read more about the custom wrapper and why it exists [here](https://gith
  7. [Running tests on local stargate](#running-tests-on-local-stargate)
  8. [Running tests without a specific test tag](#running-tests-without-a-specific-test-tag)
  9. [Running tests with logging](#running-tests-with-logging)
+5. [See also](#see-also)
 
 ## Prerequisites
 
@@ -182,7 +183,7 @@ If you're running the tests on a local Stargate instance, you can use this flag
 
 It'll also automatically set the environment to `dse`.
 
-Note that you'll still need to run stargate yourself. See [startgate.sh.md](./startgate) for more info.
+Note that you'll still need to run stargate yourself. See [startgate.sh.md](./startgate.sh.md) for more info.
 
 ### 10. Enable verbose logging for tests (`[(-l | -logging) | (-L | -logging-with-pred <predicate>)]`)
 
@@ -325,3 +326,8 @@ scripts/test.sh -l
 # Though sometimes I want something more specific
 scripts/test.sh -L '!isGlobal && e.commandName === "find"'
 ```
+
+## See also
+
+- [The custom checker script](./check.sh.md)
+- [Local Data API spawning script](./startgate.sh.md)