Skip to content

docs: initial upload of styles used by doc linter - #46854

Closed
bob-watson wants to merge 17 commits into
angular:mainfrom
bob-watson:doc-linter
Closed

bob-watson wants to merge 17 commits into
angular:mainfrom
bob-watson:doc-linter

Conversation

@bob-watson

Copy link
Copy Markdown
Contributor

Adds styles and configuration files for contributors to use the Vale documentation linter in their IDE while they edit angular.io topics.
This commit includes documentation for using the documentation linter in the README.md file.
This commit does not alter any angular.io or other published documentation.

@bob-watson

Copy link
Copy Markdown
Contributor Author

This commit is going to cause problems with the inclusive language CI test because it includes files with all the prohibited words in its tests to look for those words in the documentation.

Is there a way to mark those file(s) as allowable exceptions to this CI test? It looks like it's only two files:

  • aio/tools/doc-linter/dictionaries/en_us/en_US-web.dic
  • aio/tools/doc-linter/styles/Angular/Angular_Inclusive.yml

@bob-watson bob-watson added the target: patch This PR is targeted for the next patch release label Jul 15, 2022

@josmar-crwdstffng josmar-crwdstffng left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lgtm
Reviewed-for: global-docs-approvers

I have confirmed that the definitions work as intended and match the standalone repo.

Comment thread aio/tools/doc-linter/vale.ini Outdated
Comment thread aio/tools/doc-linter/vale.ini Outdated
Comment thread aio/tools/doc-linter/styles/Angular/Angular_Note.yml Outdated
Comment thread aio/tools/doc-linter/styles/Angular/Angular_Code-as-word.yml Outdated
Comment thread aio/tools/doc-linter/README.md Outdated
Comment thread aio/tools/doc-linter/README.md Outdated
Comment thread aio/tools/doc-linter/README.md Outdated
Comment thread aio/tools/doc-linter/README.md Outdated
Comment thread aio/tools/doc-linter/README.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean "git workspace" or "git working directory" (here and below)?
I don't think "github workspace directory" is a thing (but I might be wrong).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be (and now is) workspace directory. Thanks!

Comment thread aio/tools/doc-linter/README.md Outdated
Bob Watson and others added 3 commits July 18, 2022 14:18
…tyles (#46863)

style values get added to the `_globalTimelineStyles` map in order to keep
them so that they can be used across different timelines

`_globalTimelineStyles` was previously a plain object but has been
refactored to a map in #44482, as part of the update a check has been
changed from a ternary operation to an or (||), causing falsy values (as 0)
not to be added to the map anymore, apply the nullish coalescing operator (??)
instead to make sure only `undefined` and `null` are filtered out

also since this aspect was clearly not covered by tests, add a new test
to ensure that such regression doesn't happen in the future

resolves #46833

PR Close #46863
The implementation of the `DefaultTitleStrategy` was modeled after the
existing strategy patterns in the Router. These patterns were developed
before the `providedIn` syntax for injectables. We can simplify the
model a lot by providing the default in the factory of the abstract
class.

Note that the other strategy patterns aren't touched in this PR due to
how long they've existed. Because they have been there for such a long
time, it's possible there will need to be some adjustments to code
if/when they are refactored to do the same.

PR Close #46876
@bob-watson
bob-watson requested a review from gkalpak July 19, 2022 15:41
angular-robot and others added 14 commits July 19, 2022 16:04
See associated pull request for more information.

PR Close #46883
See associated pull request for more information.

PR Close #46884
See associated pull request for more information.

PR Close #46885
The `runInContext` for `NgModuleRef` was previously an infinite loop.

PR Close #46877
The source-map package is updated as part #46707, but the minor
version bump introduced breaking changes. This commit extracts the
update so that we can handle it separately accounting for the breaking
changes. Also removing the caret since this package apparently makes
breaking changes in minor segment bumps.

PR Close #46888
…nal list (#46888)

The source-map package is no longer explicitly used in the
`compiler-cli` package and therefore can be removed from the ESBuild
bundling, denoting it as external. This should be a noop.

PR Close #46888
…ange (#46888)

The source-map package now requires the
`SourceMapConsumer`/`SourceMapGenerator` classes to be instantiated
asynchronously. This commit updates our tests to account for that.

PR Close #46888
The sourcemap test in the e2e playground is now using async/await code.
This results in errors now with the Bazel TS compilation because it
detects that `expect` is returning a promise and should be awaited.

This happens due to the jasminewd2 types. We should just use the actual
jasmine types and not rely on the deprecated selenium control flow,
using explicit async/await in the whole test. This also solves the issue
with the source-map types being async/await now.

PR Close #46888
… `fakeAsync` (#46888)

The source map tests rely on asynchronous logic from the `source-map`
package. The tests itself are written using `fakeAsync` but this
unnecessarily complicates the interaction with the asynchronous
source-map helpers/package.

To fix this, we just make the tests use async/await as we don't intend
to test fakeAsync in this `describe` block..

PR Close #46888
@bob-watson

Copy link
Copy Markdown
Contributor Author

The commits in this branch got all tangled up and look worse than the actual changes that were made.
Closing this PR and replacing with PR #46897.

@bob-watson bob-watson closed this Jul 19, 2022
@bob-watson
bob-watson deleted the doc-linter branch July 20, 2022 22:36
@angular-automatic-lock-bot

Copy link
Copy Markdown

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot Bot locked and limited conversation to collaborators Aug 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

target: patch This PR is targeted for the next patch release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants