Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Latest commit

 

History

History
27 lines (20 loc) · 2.49 KB

Readme.md

File metadata and controls

27 lines (20 loc) · 2.49 KB
Raw

Lessons Learned Using Typescript in Node 10.x

Basic Usage

  1. Clone the repo
  2. npm test to run all the tests
  3. npm run test:fund to run only the fundamental tests
  4. npm run test:adv to run only the advanced tests
  5. Read the results
  6. If you see test results that look interesting look for a top level test Link to this test: <some link here> <-🐞 and click the link to examine the code

Contribute lessons learned

Coding Guidelines

  1. Read some of the tests and try to emulate the descriptive style of the describes and it statements. The goal is that the output from your tests is all someone needs to get a basic understanding of what lesson is being shown. It is reasonable to expect them to look at the code of the test to fully understand the lesson.
  2. Optionally you can the words FUNDAMENTAL or ADVANCED to the description for the test. If the topmost description contains ADVANCED then npm run test:adv will execute the tests contained therein. If the description contains FUNDAMENTAL then npm run:fund will run those tests. npm test will run all the tests.
  3. Ideally you will only have a test file, but if you need a separate source file, it is recommended that you keep the source and test files together in the same folder.
  4. If you have a collection of related lessons feel free to create a folder under src.
  5. Consider using uut for unit under test if you create an object instance of a class that is the main object for the test. This is a guideline not a "rule" but the first tests were written with this convention so it will make it easier on learners if consistent naming is used.
  6. Write in TypeScript. If you have an idea for a lesson learned, but it only applies to JavaScript, it doesn't belong here. (This one is kind of a rule.)
  7. Also optionally, under your first describe add an it('Link to this test: src/advanced/nameOfTest.test.ts:15)', () => {}) where nameOfTest and 15 are replaced with your file name and line number of the top level describe.
  8. Don't leave console.log or other terminal output in your code.

Editorial (or lack thereof)

The intent of this repository was to capture lessons and techniques. The fact that a technique is here is not meant to encourage nor discourage the use of a particular technique. It is expected that some techniques shown here will be, or are already, replaced by newer language features. Since not all environments support the latest language features it is not envisioned that older techniques will be pruned.