Updated to minimal standard eslint config #2814
Conversation
GeoffCoxMSFT
requested review from
joshgummersall,
stevengum and
munozemilio
Pull Request Test Coverage Report for Build 171019
💛 - Coveralls |
| ], | ||
| "overrides": [ | ||
| { | ||
| "files": ["libraries/adaptive-expressions/src/*.ts", "libraries/adaptive-expressions/src/**/*.ts"], |
There was a problem hiding this comment.
@stevengum where did we land on dropping jsdoc linting? I thought it might still be useful to include as a warning but I could be mistaken there.
There was a problem hiding this comment.
@JonathanFingold can you indicate what the correct practice is here? More specifically which tools and configurations (if any) should we leave in the JS repo for generating the docs?
There was a problem hiding this comment.
Researching. I'll post here when I know more.
There was a problem hiding this comment.
My plan is to restore the js-doc - maybe with fewer rule exceptions - once we have the code issues fixed.
There was a problem hiding this comment.
TypeDoc
We use TypeDoc behind the scenes for TypeScript documentation (recommended reading: platform breakdown). To make sure that the content renders properly, please ensure that the TypeScript APIs are using standard TypeDoc conventions, available here.
Linting & structure enforcement
You can use ESLint, in combination with valid-jsdoc to make sure that your JSDoc comments are in good shape.
For TypeScript, you can use tslint, with the completed-docs rule.
Use [link-text](xref:uid) style links to link to other Bot Framework and Microsoft TypeScript ref docs.
To find the xref for JavaScript, go to https://docs.microsoft.com/en-us/javascript/api/ and search for the member you want to link to. The xref will be the link text, as opposed to the link target. For example, the xref for the BotAdapter.use method is botbuilder-core.BotAdapter.use.
For links into our docs, link "directly" to the article, such as https://docs.microsoft.com/azure/bot-service/bot-builder-howto-send-messages for the Send and receive text messages how to.
package.json
Outdated
| "eslint-plugin-prettier": "^3.1.4", | ||
| "eslint-plugin-security": "^1.4.0", | ||
| "prettier": "^2.1.2", | ||
| "typescript": "^3.9.7" |
There was a problem hiding this comment.
I don't think we're using this version of Typescript yet (unfortunately 😢), I suspect this is the version that Prettier is using for parsing? It would probably be best to keep this consistent with whatever is most widely used across all the libraries.
There was a problem hiding this comment.
I can remove it for now. Maybe it is better defined per library.
There was a problem hiding this comment.
I like the idea of a peerDependency in each package; with the root package.json having a it as a devDependency. Right now we're pinned to 3.5.3 because 3.6 introduced some breaking changes. @joshgummersall is investigating our migration story for TypeScript.
There was a problem hiding this comment.
I think peerDependency is used to express "runtime dependencies" rather than build time dependencies. We don't want to express typescript a runtime dependency because the compiled JS we're publishing has no dependency on typescript. IIRC, lerna supports hoisted dependencies such that we could list [email protected] in the root package.json and a different one in packages that differ. That's how yarn workspaces functionality works.
There was a problem hiding this comment.
npm behavior changed to not restore peerDependencies (quite awhile ago I think). Composer is using peer dependencies to avoid including multiple different versions of a package when one has ^1.0.1 and another has ^1.0.2. We don't need to use peerDependencies for devDependencies though as peerDependenicies are only resolved through the top level dependencies list.
There was a problem hiding this comment.
We use this tool in azure-sdk-for-js to support below TS 3.6 in our public typings: https://github.com/sandersn/downlevel-dts
There was a problem hiding this comment.
@xirzec that's great news! That's exactly the tool I was looking at.
Description
First step to standardizing the minimal lint rules for the TS/JS SDK.
Specific Changes
Testing
N/A