Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for extends to typescript config and babel config parsers #973

Merged
merged 7 commits into from
Apr 9, 2018
Merged

Add support for extends to typescript config and babel config parsers #973

merged 7 commits into from
Apr 9, 2018

Conversation

sarvaje
Copy link
Contributor

@sarvaje sarvaje commented Apr 3, 2018 •
edited
Loading

Fix #943

Pull request checklist

Make sure you:

For non-trivial changes, please make sure you also:

  • Added/Updated related documentation.
  • Added/Updated related tests.

Short description of the change(s)

molant
molant requested changes Apr 6, 2018
View reviewed changes
packages/parser-typescript-config/src/parser.ts Outdated
@@ -67,6 +71,28 @@ export default class TypeScriptConfigParser extends Parser {
try {
config = JSON.parse(fetchEnd.response.body.content);

const originalConfig = cloneDeep(config);

try {
Copy link
Member

Choose a reason for hiding this comment

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

Nested try? Isn't there a way to refactor this?

packages/parser-typescript-config/src/parser.ts Outdated
try {
config = finalConfig(config, resource);
} catch (err) {
if (err.code === ErrorCodes.circular) {
Copy link
Member

Choose a reason for hiding this comment

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

This checks is also in Babel. Can't it be refactored and maybe added to the Parser class so it's available in all Parsers?

@sarvaje
Copy link
Contributor Author

sarvaje commented Apr 6, 2018

@molant I have moved some code to Parser and I have added some tests and modify the docs

molant
molant approved these changes Apr 7, 2018
View reviewed changes
Copy link
Member

@molant molant left a comment

Choose a reason for hiding this comment

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

LGTM, @alrra do you want to take a look?

@molant
Copy link
Member

molant commented Apr 7, 2018

@sarvaje looks like there are some errors with the tests:

rule-typescript-config › dist › tests › is-valid › [local] If the configuration has a circular reference, it should fail Different message
parser-javascript › dist › tests › tests › If an script tag is an internal javascript, then we should parse the code and emit a parse::javascript::end event Rejected promise returned by test
parser-javascript › dist › tests › tests › If fetch::end::script is received, then we should parse the code and emit a parse::javascript::end event Rejected promise returned by test

alrra
alrra reviewed Apr 8, 2018
View reviewed changes
packages/parser-babel-config/README.md
* `resource`: the parsed resource.
* `error`: the error emited parsing the configuration file.

* `parse::babel-config::error::extends`, of type `BabelConfigInvalidJSON`
Copy link
Contributor

Choose a reason for hiding this comment

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

Note: In a conversation with @molant we talked about not having the ...error::not-found (or similar events) as most of the time just one rule will needed it, and in that case, the rule can have that logic in it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can you open an issue for that?

Copy link
Member

Choose a reason for hiding this comment

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

#960

packages/sonarwhal/docs/contributor-guide/how-to/parser.md Outdated
@@ -13,7 +13,7 @@ import { Sonarwhal } from '../../sonarwhal';
export default class CustomParser extends Parser {

public constructor(sonarwhal: Sonarwhal) {
super(sonarwhal);
super(sonarwhal, 'parser-name');
Copy link
Contributor

Choose a reason for hiding this comment

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

For consistency, maybe use:

<parser_name>

packages/sonarwhal/docs/contributor-guide/how-to/parser.md Outdated
@@ -26,7 +26,7 @@ export default class CustomParser extends Parser {
// and maybe leter use a schema if a configuration file or something else

// If there's something to share, do it via an event
await this.sonarwhal.emitAsync('customparser::custom', data);
await this.sonarwhal.emitAsync('parse::parser-name::<end | error>', data);
Copy link
Contributor

Choose a reason for hiding this comment

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

<parser_name> ?

packages/sonarwhal/docs/contributor-guide/how-to/parser.md Outdated
@@ -40,7 +40,7 @@ Once you have analyzed the resource, the way to share information is via
events (custom or not):

```ts
await this.sonarwhal.emitAsync('customparser::custom', data);
await this.sonarwhal.emitAsync('parse::parse-name::<end | error>', data);
Copy link
Contributor

Choose a reason for hiding this comment

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

<parser_name> ?

@alrra alrra mentioned this pull request Apr 8, 2018
Closed
4 tasks
@sarvaje
Copy link
Contributor Author

sarvaje commented Apr 9, 2018

@alrra done!

Also, tests should be fixed.

@molant molant merged commit a539944 into webhintio:master Apr 9, 2018
@sarvaje sarvaje deleted the fix-943 branch May 10, 2018 23:09
This was referenced Jan 12, 2022
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@molant molant molant approved these changes

@alrra alrra alrra left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

In babel and typescript parsers, build the full configuration when they are using extends.
3 participants
@sarvaje @molant @alrra