Skip to content

Commit

Permalink
[JS] chore: file cleanup and unit tests (#1183)
Browse files Browse the repository at this point in the history
## Linked issues

Fixes: #1163, closes #1181
related to: #239 #54 

## Details

- Fixes MemoryFork doc strings
- Fixes TurnState doc strings
- Adds missing docs to several classes/methods
  - Adaptive Cards
  - TurnState
  - OpenAIEmbeddings
  - Azure OpenAI Client
  - testing folder
  - Layout Engine
  - System Message
  - User Input Message 
  - User Message
  - Action Response Validator
  - Default Response Validator
  - JSON Response Validator
  - Response
  - Teams Chef Bot files
- Fix `api-extractor` script to generate an updated version of
`teams-ai.api.json` -- it was very out of date
- Fix `typedoc`script to work. I did not merge in generated docs though;
we have never used the docs site and I'm not convinced we need it. But
at least the script works for if we decide to keep it.
- Move `Test____.ts` files into `packages/src/internals/testing` --
these are mini-modules used exclusively for testing, and for better
findability I decided to move them.
- Updated eslintrc for Teams Chef Bot to allow `@remarks`
- dev packages:
  - remove typedoc (unused)
  - remove unused typedoc script

## Attestation Checklist

- [x] My code follows the style guidelines of this project

- I have checked for/fixed spelling, linting, and other errors
- I have commented my code for clarity
- I have made corresponding changes to the documentation (we use
[TypeDoc](https://typedoc.org/) to document our code)
- My changes generate no new warnings
- I have added tests that validates my changes, and provides sufficient
test coverage. I have tested with:
  - Local testing
  - E2E testing in Teams
- New and existing unit tests pass locally with my changes

---------

Co-authored-by: Corina Gum <>
  • Loading branch information
corinagum authored Jan 23, 2024
1 parent a22670e commit 8b51dbb
Show file tree
Hide file tree
Showing 67 changed files with 30,435 additions and 14,102 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Provide a list of your changes here. If you are fixing a bug, please provide ste

- I have checked for/fixed spelling, linting, and other errors
- I have commented my code for clarity
- I have made corresponding changes to the documentation (we use [TypeDoc](https://typedoc.org/) to document our code)
- I have made corresponding changes to the documentation (updating the doc strings in the code is sufficient)
- My changes generate no new warnings
- I have added tests that validates my changes, and provides sufficient test coverage. I have tested with:
- Local testing
Expand Down
2 changes: 1 addition & 1 deletion js/.nycrc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"include": ["packages/**/src/**/*.ts", "lib/**/*.js"],
"exclude": [
"**/node_modules/**",
"**/tests/**",
"**/testing/**",
"**/coverage/**",
"**/*.d.ts",
"**/*.spec.ts",
Expand Down
2 changes: 0 additions & 2 deletions js/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,6 @@
"sponge": "^0.1.0",
"tinyify": "^4.0.0",
"ts-node": "^10.9.2",
"typedoc": "^0.25.7",
"typedoc-plugin-markdown": "^3.17.1",
"typescript": "^5.3.3",
"wsrun": "^5.2.4"
}
Expand Down
Loading

0 comments on commit 8b51dbb

Please sign in to comment.