EDU-15496 - Implementing FastStore Analyzer #2032
Open
+115
−0
Conversation
This file contains hidden or 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
Navigation Preview LinkNo changes detected in the navigation.json file |
Preview LinksOpen this URL to set up the portal with this branch changes. You can now access the edited pages with the following URLs:
|
…alyzer LOC-20587 - EDU-15496 - Implementing FastStore Analyzer #2032
Grammar review summaryReview for
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| | `cssOptions` | `object` | Options for validating and transforming CSS namespace usage. | | ||
| | ├─`allowedNamespaces` | `string` | Array of allowed CSS namespace prefixes (example: `['extension-']`). Only selectors with these prefixes will be considered compliant. | | ||
| | ├─`transformNonCompliant` | `boolean` | If `true`, automatically updates non-compliant CSS selectors to match the expected namespace format. | | ||
| | ├─`defaultNamespace` | `string` | Default namespace prefix applied to selectors when auto-fixing non-compliant CSS (example: ` 'extension-'`. | |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD038/no-space-in-code Spaces inside code span elements [Context: " 'extension-'"]
|
|
||
| In this guide, you'll learn how to securely implement [Extension points](LINK) in [FastStore modules](LINK) by using FastStore Analyzer. | ||
|
|
||
| FastStore Analyzer is a static analysis tool that helps maintain code quality and security in FastStore projects. By integrating it into your development workflow with customizable CLI hooks, it scans your codebase to identify issues before they affect your build. |
There was a problem hiding this comment.
📝 [Grammar reviewer] reported by reviewdog 🐶
Rephrasing improves sentence flow and clarity by making 'FastStore Analyzer' the clear subject of the scanning action, avoiding the slightly awkward 'By integrating it... it scans' construction.
Suggested change
| FastStore Analyzer is a static analysis tool that helps maintain code quality and security in FastStore projects. By integrating it into your development workflow with customizable CLI hooks, it scans your codebase to identify issues before they affect your build. | |
| FastStore Analyzer is a static analysis tool that helps maintain code quality and security in FastStore projects. Integrated into your development workflow with customizable CLI hooks, FastStore Analyzer scans your codebase to identify issues before they affect your build. |
| - `preDev`: Runs before the development server starts. | ||
| - `postDev`: Runs after the development server starts. | ||
|
|
||
| >ℹ Hooks are defined in the `src/hooks` folder and are executed according to the file name (example: `pre.ts` will run before `post.ts`). |
There was a problem hiding this comment.
📝 [Grammar reviewer] reported by reviewdog 🐶
Using 'e.g.' (exempli gratia) or 'For example,' is more formal and standard in technical documentation than 'example:'.
Suggested change
| >ℹ Hooks are defined in the `src/hooks` folder and are executed according to the file name (example: `pre.ts` will run before `post.ts`). | |
| >ℹ Hooks are defined in the `src/hooks` folder and are executed according to the file name (e.g., `pre.ts` will run before `post.ts`). |
|
|
||
| | Field | Type | Description | | ||
| |:------|:-----|:------------| | ||
| | `filePattern` | `string` | Glob pattern defining the files to be analyzed (example: `.{js,ts,jsx,tsx,css,less,scss}`). **Replace `{{your-module}}` based on your scenario.** | |
There was a problem hiding this comment.
📝 [Grammar reviewer] reported by reviewdog 🐶
Using 'e.g.' (exempli gratia) or 'For example,' is more formal and standard in technical documentation than 'example:'.
Suggested change
| | `filePattern` | `string` | Glob pattern defining the files to be analyzed (example: `.{js,ts,jsx,tsx,css,less,scss}`). **Replace `{{your-module}}` based on your scenario.** | | |
| | `filePattern` | `string` | Glob pattern defining the files to be analyzed (e.g., `.{js,ts,jsx,tsx,css,less,scss}`). **Replace `{{your-module}}` based on your scenario.** | |
| |:------|:-----|:------------| | ||
| | `filePattern` | `string` | Glob pattern defining the files to be analyzed (example: `.{js,ts,jsx,tsx,css,less,scss}`). **Replace `{{your-module}}` based on your scenario.** | | ||
| | `cssOptions` | `object` | Options for validating and transforming CSS namespace usage. | | ||
| | ├─`allowedNamespaces` | `string` | Array of allowed CSS namespace prefixes (example: `['extension-']`). Only selectors with these prefixes will be considered compliant. | |
There was a problem hiding this comment.
📝 [Grammar reviewer] reported by reviewdog 🐶
Using 'e.g.' (exempli gratia) or 'For example,' is more formal and standard in technical documentation than 'example:'.
Suggested change
| | ├─`allowedNamespaces` | `string` | Array of allowed CSS namespace prefixes (example: `['extension-']`). Only selectors with these prefixes will be considered compliant. | | |
| | ├─`allowedNamespaces` | `string` | Array of allowed CSS namespace prefixes (e.g., `['extension-']`). Only selectors with these prefixes will be considered compliant. | |
| | `cssOptions` | `object` | Options for validating and transforming CSS namespace usage. | | ||
| | ├─`allowedNamespaces` | `string` | Array of allowed CSS namespace prefixes (example: `['extension-']`). Only selectors with these prefixes will be considered compliant. | | ||
| | ├─`transformNonCompliant` | `boolean` | If `true`, automatically updates non-compliant CSS selectors to match the expected namespace format. | | ||
| | ├─`defaultNamespace` | `string` | Default namespace prefix applied to selectors when auto-fixing non-compliant CSS (example: ` 'extension-'`. | |
There was a problem hiding this comment.
📝 [Grammar reviewer] reported by reviewdog 🐶
Using 'e.g.' (exempli gratia) or 'For example,' is more formal and standard in technical documentation than 'example:'. Also, removed an unnecessary space before the single quote for better typography.
Suggested change
| | ├─`defaultNamespace` | `string` | Default namespace prefix applied to selectors when auto-fixing non-compliant CSS (example: ` 'extension-'`. | | |
| | ├─`defaultNamespace` | `string` | Default namespace prefix applied to selectors when auto-fixing non-compliant CSS (e.g., `'extension-'`). | |
| | `cssOptions` | `object` | Options for validating and transforming CSS namespace usage. | | ||
| | ├─`allowedNamespaces` | `string` | Array of allowed CSS namespace prefixes (example: `['extension-']`). Only selectors with these prefixes will be considered compliant. | | ||
| | ├─`transformNonCompliant` | `boolean` | If `true`, automatically updates non-compliant CSS selectors to match the expected namespace format. | | ||
| | ├─`defaultNamespace` | `string` | Default namespace prefix applied to selectors when auto-fixing non-compliant CSS (example: ` 'extension-'`. | |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
Suggested change
| | ├─`defaultNamespace` | `string` | Default namespace prefix applied to selectors when auto-fixing non-compliant CSS (example: ` 'extension-'`. | | |
| | ├─`defaultNamespace` | `string` | Default namespace prefix applied to selectors when auto-fixing non-compliant CSS (example: `'extension-'`. | |
github-actions
bot
force-pushed
the
main
branch
from
fd49c61 to
bba71c2
Compare
github-actions
bot
force-pushed
the
main
branch
from
207b06e to
1315392
Compare
github-actions
bot
force-pushed
the
main
branch
2 times, most recently
from
44809f5 to
9e4dab3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Types of changes
EDU-15496