feat(typewriter): Add docTags map to DocsSpec interface. #538
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
mrgrain
previously requested changes
Sep 18, 2023
|
The PR title also needs some tweaking. Different scope and in the context of this repo, I'd say this will be a feature. |
mikewrighton
changed the title
mikewrighton
changed the title
auto-merge was automatically disabled
September 20, 2023 07:33
Pull request was converted to draft
rix0rrr
approved these changes
Sep 20, 2023
mikewrighton
dismissed
mrgrain’s stale review
Addressed comment in latest commit
mergify bot
pushed a commit
to aws/aws-cdk
that referenced
this pull request
Sep 22, 2023
Various fixes to awslint. Also adds new exclusions to prevent existing lint errors from failing the build - will address these errors in a follow-up. Linter config, including exclusions, has been moved into a new file `awslint.json`. If this file does not exist, the linter will continue reading and updating the config in `package.json`. Fixes #26839. Linter changes: - Include symbols from submodules by using e.g. `assembly.allClasses` instead of `assembly.classes` - Fix FQNs in the construct linter by including the submodule name - Use `cloudformationResource` tag (added in cdklabs/awscdk-service-spec#538) to store CFN resource ID when generating L1 constructs. This is used in the CFN resource linter. - Fix `core-types.ts` to use new package names - Ignore version suffixes when guessing resource names in `packages/awslint/lib/rules/resource.ts` The change in `aws-apigateway/lib/resource.ts` is an example of a `props-physical-name` fix. Breakdown of new linter errors: ``` docs-public-apis: 2308 props-default-doc: 214 props-physical-name: 106 attribute-tag: 13 construct-interface-extends-iconstruct: 8 resource-interface-extends-resource: 8 from-method: 8 props-no-cfn-types: 7 ref-via-interface: 5 from-signature: 4 construct-ctor-props-optional: 3 props-no-arn-refs: 3 props-no-any: 2 integ-return-type: 2 module-name: 1 construct-ctor: 1 props-struct-name: 1 construct-ctor-props-type: 1 no-static-import: 1 public-static-props-all-caps: 1 Total: 2697 ``` ### Tasks - [x] Push cdklabs/awscdk-service-spec#538 before merging *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
docTagsfield to the DocSpec interface.This is a dependency of aws/aws-cdk#26839.