Refactor the internal API #6415
Conversation
This refactoring aims to make the codebase around the internal API more consistent. Our codebase is mostly FP style, so the OOP-like code using `.bind()` seems inconsistent to me. Also, the dependency between the internal modules seems implicit through `.bind()`.
|
| ) => Promise<LintResult>; | ||
|
|
||
| getConfigForFile: (searchPath?: string, filePath?: string) => Promise<CosmiconfigResult>; | ||
| isPathIgnored: (s?: string) => Promise<boolean>; |
There was a problem hiding this comment.
[note] I believe InternalApi and createLinter is private and never break our ecosystem.
stylelint/types/stylelint/index.d.ts
Lines 458 to 463 in d402889
However, if this pull request would harm the ecosystem, I'd like to close it.
| @@ -0,0 +1,26 @@ | |||
| 'use strict'; | |||
There was a problem hiding this comment.
[note] createLinter.test.js is divided into two files.
| const ignoreFiles = /** @type {Array<string>} */ (result.config.ignoreFiles || []).map((s) => | ||
| normalizePath(s), | ||
| ); | ||
| const ignoreFiles = [result.config.ignoreFiles || []].flat().map((s) => normalizePath(s)); |
There was a problem hiding this comment.
[note] The technique using .flat() has an advantage for the type inference.
| throw err; | ||
| }); | ||
| } | ||
| } |
There was a problem hiding this comment.
[note] This refactoring makes the code consistent using async/await.
|
Thanks for the quick review! 😄 |
|
Hi @jeddy3 |
|
@jeddy3 @ybiquitous Friendly ping |
|
@ricardogobbosouza @alexander-akait stylelint/types/stylelint/index.d.ts Lines 521 to 526 in b70929b However, I'll gladly cooperate to fix the problem. |
|
@ybiquitous Yeah, I think we should move such things from public api to prevent such situaltion, or use |
|
Agree. I'll add |
None.
This refactoring aims to make the codebase around the internal API more consistent.
Our codebase is mostly FP style, so the OOP-like code using
.bind()seems inconsistent to me.Also, the dependency between the internal modules seems implicit through
.bind().