Format all file types supported by Prettier #1686
Conversation
WalkthroughThis pull request applies widespread formatting, configuration, and dependency updates across the repository. ESLint and Prettier settings were revised, GitHub Actions workflow files reorganized, and numerous Node, CSS/SCSS, documentation, and test files were reformatted for consistency and clarity. Dependency versions and package scripts were updated, and some obsolete configuration files were removed. Overall, these changes improve readability and maintainability without altering the control flow or core functionality. Changes
Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
2 times, most recently
from
af9f19e to
1ffb14e
Compare
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
2 times, most recently
from
e54f3c2 to
22a4598
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🔭 Outside diff range comments (1)
lib/generators/react_on_rails/templates/.eslintrc (1)
Line range hint
2-24: Add TypeScript-specific ESLint configuration.Given that one of the PR objectives is to enhance TypeScript formatting, consider adding TypeScript-specific ESLint configuration:
extends: - eslint-config-shakacode - prettier + - prettier/@typescript-eslint + - plugin:@typescript-eslint/recommended plugins: - react + - @typescript-eslint globals: __DEBUG_SERVER_ERRORS__: true __SERVER_ERRORS__: true env: browser: true node: true mocha: true rules: no-console: 0 # https://github.com/benmosher/eslint-plugin-import/issues/340 import/no-extraneous-dependencies: 0 # because template cannot find react-on-rails import/no-unresolved: 0
♻️ Duplicate comments (3)
.github/workflows/main.yml (3)
76-76:⚠️ Potential issueFix deprecated GitHub Actions commands.
These lines use the deprecated
set-outputcommand. Apply the same fix as suggested in examples.yml.Also applies to: 136-136
🧰 Tools
🪛 actionlint (1.7.4)
76-76: workflow command "set-output" was deprecated. use
echo "{name}={value}" >> $GITHUB_OUTPUTinstead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions(deprecated-commands)
70-70: 🛠️ Refactor suggestionImprove shell script reliability.
These lines use the potentially problematic
A && B || Cpattern. Apply the same fix as suggested in examples.yml.Also applies to: 153-153, 155-155
🧰 Tools
🪛 actionlint (1.7.4)
70-70: shellcheck reported issue in this script: SC2015:info:1:60: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
157-167:⚠️ Potential issueFix numeric comparison in shell script.
The comparison operator should be
-ltinstead of<. Apply the same fix as suggested in examples.yml.🧰 Tools
🪛 actionlint (1.7.4)
157-157: shellcheck reported issue in this script: SC2071:error:4:39: < is for string comparisons. Use -lt instead
(shellcheck)
🧹 Nitpick comments (5)
node_package/src/reactHydrateOrRender.ts (1)
8-24: Track TODO for React 18 upgrade.The code includes a TODO comment indicating this complex optional dependency handling can be simplified once React is upgraded to version 18 or higher.
Would you like me to create an issue to track this TODO for future cleanup when React is upgraded?
node_package/src/ReactOnRails.ts (2)
69-72: Consider using template literals for better readability.The error message could be more readable using template literals instead of string concatenation.
- throw new Error( - 'Called ReactOnRails.registerStoreGenerators with a null or undefined, rather than ' + - 'an Object with keys being the store names and the values are the store generators.', - ); + throw new Error(` + Called ReactOnRails.registerStoreGenerators with a null or undefined, rather than + an Object with keys being the store names and the values are the store generators. + `);
259-261: Consider using template literals for consistency.For consistency with other error messages in the file, consider using template literals.
- throw new Error( - 'streamServerRenderedReactComponent is only supported when using a bundle built for Node.js environments', - ); + throw new Error(` + streamServerRenderedReactComponent is only supported when using a bundle built for Node.js environments + `);lib/generators/react_on_rails/templates/.eslintrc (1)
Line range hint
18-24: Review semi rule configuration with Prettier.The
semi: 0rule might conflict with Prettier's semicolon formatting. Consider removing this rule and letting Prettier handle semicolon formatting consistently.rules: no-console: 0 # https://github.com/benmosher/eslint-plugin-import/issues/340 import/no-extraneous-dependencies: 0 # because template cannot find react-on-rails import/no-unresolved: 0 - semi: 0package-scripts.yml (1)
72-76: Consider separating JSON and YAML formatting.While combining JSON and YAML formatting works, consider separating them for:
- Better control over file patterns
- Independent verification
- Clearer error reporting
json: default: - description: Run prettier on JSON and YAML files. - script: rm -rf packages/vm-renderer/tests/tmp && prettier "**/*.@(json|yaml)" "**/.*rc" --write + description: Run prettier on JSON files. + script: prettier "**/*.json" "**/.*rc" --write listDifferent: - description: Check if any JSON or YAML files would change by running prettier. - script: prettier "**/*.@(json|yaml)" "**/.*rc" --check + description: Check if any JSON files would change by running prettier. + script: prettier "**/*.json" "**/.*rc" --check +yaml: + default: + description: Run prettier on YAML files. + script: prettier "**/*.yaml" --write + listDifferent: + description: Check if any YAML files would change by running prettier. + script: prettier "**/*.yaml" --check
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (42)
.circleci/config.yml(0 hunks).eslintrc(0 hunks).github/workflows/examples.yml(2 hunks).github/workflows/lint-js-and-ruby.yml(1 hunks).github/workflows/main.yml(2 hunks).github/workflows/package-js-tests.yml(1 hunks).github/workflows/rspec-package-specs.yml(1 hunks).prettierignore(1 hunks).prettierrc(1 hunks).scss-lint.yml(1 hunks).travis.yml(2 hunks)lib/generators/react_on_rails/templates/.eslintrc(1 hunks)lib/generators/react_on_rails/templates/base/base/config/shakapacker.yml(1 hunks)node_package/src/Authenticity.ts(1 hunks)node_package/src/ComponentRegistry.ts(1 hunks)node_package/src/ReactOnRails.ts(6 hunks)node_package/src/StoreRegistry.ts(4 hunks)node_package/src/buildConsoleReplay.ts(2 hunks)node_package/src/clientStartup.ts(10 hunks)node_package/src/context.ts(1 hunks)node_package/src/createReactOutput.ts(3 hunks)node_package/src/handleError.ts(2 hunks)node_package/src/isRenderFunction.ts(1 hunks)node_package/src/isServerRenderResult.ts(1 hunks)node_package/src/reactApis.ts(1 hunks)node_package/src/reactHydrateOrRender.ts(1 hunks)node_package/src/serverRenderReactComponent.ts(8 hunks)node_package/src/serverRenderUtils.ts(2 hunks)node_package/src/streamServerRenderedReactComponent.ts(4 hunks)node_package/src/types/index.ts(6 hunks)package-scripts.yml(1 hunks)package.json(1 hunks)rakelib/examples_config.yml(1 hunks)spec/dummy/.prettierignore(0 hunks)spec/dummy/.prettierrc(0 hunks)spec/dummy/client/.eslintrc(0 hunks)spec/dummy/client/.jscsrc(1 hunks)spec/dummy/config/locales/en.yml(1 hunks)spec/dummy/config/shakapacker.yml(1 hunks)spec/dummy/config/storage.yml(0 hunks)spec/react_on_rails/fixtures/i18n/locales/de.yml(1 hunks)spec/react_on_rails/fixtures/i18n/locales/en.yml(1 hunks)
💤 Files with no reviewable changes (6)
- spec/dummy/.prettierrc
- spec/dummy/client/.eslintrc
- spec/dummy/config/storage.yml
- spec/dummy/.prettierignore
- .eslintrc
- .circleci/config.yml
✅ Files skipped from review due to trivial changes (23)
- node_package/src/reactApis.ts
- .github/workflows/package-js-tests.yml
- spec/react_on_rails/fixtures/i18n/locales/en.yml
- rakelib/examples_config.yml
- spec/dummy/client/.jscsrc
- .github/workflows/lint-js-and-ruby.yml
- node_package/src/handleError.ts
- node_package/src/createReactOutput.ts
- node_package/src/context.ts
- node_package/src/serverRenderReactComponent.ts
- spec/dummy/config/shakapacker.yml
- node_package/src/isRenderFunction.ts
- spec/dummy/config/locales/en.yml
- node_package/src/streamServerRenderedReactComponent.ts
- .travis.yml
- .github/workflows/rspec-package-specs.yml
- node_package/src/serverRenderUtils.ts
- lib/generators/react_on_rails/templates/base/base/config/shakapacker.yml
- node_package/src/ComponentRegistry.ts
- node_package/src/Authenticity.ts
- .scss-lint.yml
- spec/react_on_rails/fixtures/i18n/locales/de.yml
- node_package/src/clientStartup.ts
🧰 Additional context used
🪛 GitHub Actions: Lint JS and Ruby
node_package/src/buildConsoleReplay.ts
[warning] Code style issues found. File needs to be formatted using Prettier.
🪛 actionlint (1.7.4)
.github/workflows/examples.yml
64-64: workflow command "set-output" was deprecated. use echo "{name}={value}" >> $GITHUB_OUTPUT instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions
(deprecated-commands)
72-72: shellcheck reported issue in this script: SC2015:info:1:43: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
74-74: shellcheck reported issue in this script: SC2071:error:4:39: < is for string comparisons. Use -lt instead
(shellcheck)
.github/workflows/main.yml
70-70: shellcheck reported issue in this script: SC2015:info:1:60: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
72-72: shellcheck reported issue in this script: SC2209:warning:1:18: Use var=$(command) to assign output (or quote to assign string)
(shellcheck)
76-76: workflow command "set-output" was deprecated. use echo "{name}={value}" >> $GITHUB_OUTPUT instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions
(deprecated-commands)
136-136: workflow command "set-output" was deprecated. use echo "{name}={value}" >> $GITHUB_OUTPUT instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions
(deprecated-commands)
153-153: shellcheck reported issue in this script: SC2015:info:1:43: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
155-155: shellcheck reported issue in this script: SC2015:info:1:60: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
157-157: shellcheck reported issue in this script: SC2071:error:4:39: < is for string comparisons. Use -lt instead
(shellcheck)
171-171: shellcheck reported issue in this script: SC2209:warning:1:18: Use var=$(command) to assign output (or quote to assign string)
(shellcheck)
🪛 Biome (1.9.4)
node_package/src/reactHydrateOrRender.ts
[error] 38-38: Do not depend on the value returned by the function ReactDOM.render().
The returned value is legacy and future versions of React might return that value asynchronously.
Check the React documentation for more information.
(lint/correctness/noRenderReturnValue)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: dummy-app-integration-tests (oldest)
🔇 Additional comments (24)
node_package/src/reactHydrateOrRender.ts (3)
1-6: LGTM! Clean imports and type definitions.The imports are well-organized with proper type imports, and the
HydrateOrRenderTypetype definition is clear and precise.
26-28: LGTM! Clean hydration implementation.The code elegantly handles both modern (
hydrateRoot) and legacy (hydrate) React implementations.
41-47: LGTM! Clean and readable implementation.The function signature is well-formatted across multiple lines, improving readability while maintaining a simple and correct implementation.
node_package/src/ReactOnRails.ts (4)
108-108: LGTM! Improved TypeScript type definition syntax.The change from comma to semicolon in the object type definition follows TypeScript's preferred syntax.
124-124: LGTM! Proper use of template literals for error message.The error message correctly uses template literals with JSON.stringify for formatting the invalid options.
230-234: LGTM! Improved readability of render method.The multi-line formatting enhances readability while maintaining necessary type assertions.
312-312: LGTM! Good practice to export types.Exporting types makes them available to consumers and follows TypeScript module best practices.
lib/generators/react_on_rails/templates/.eslintrc (1)
2-4: Verify ESLint and Prettier configuration compatibility.The configuration extends both
eslint-config-shakacodeandprettier. Let's verify there are no rule conflicts between these configurations.✅ Verification successful
ESLint and Prettier configuration is correctly set up ✅
The configuration extends
eslint-config-shakacodeandprettierin the correct order, with Prettier last to ensure its rules take precedence. The custom rule overrides don't conflict with Prettier's formatting rules.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check for potential ESLint and Prettier conflicts # Check if eslint-config-shakacode has its own Prettier configuration npm info eslint-config-shakacode # Look for any existing eslint-prettier configuration files fd -t f -e json -e js -e yaml -e yml . | rg -i 'prettier|eslint'Length of output: 970
Script:
#!/bin/bash # Check ESLint and Prettier configurations # Show content of the template .eslintrc cat lib/generators/react_on_rails/templates/.eslintrc # Find and show content of any Prettier config files fd -t f -e json -e js -e yaml -e yml . | rg -i 'prettier' --files-with-matches | xargs cat # Find any ESLint rule configurations that might conflict with Prettier rg -i "rules.*:|\"rules\":|'rules':" -A 10Length of output: 4905
node_package/src/StoreRegistry.ts (4)
19-22: LGTM! Improved error message formatting.The use of template literals and proper indentation enhances readability.
Line range hint
44-48: LGTM! Clear and informative error message.The multi-line format with numbered points makes the error message easy to understand and act upon.
54-57: LGTM! Consistent error message formatting.Maintains consistency with other error messages in the file.
75-78: LGTM! Consistent error message formatting.Maintains consistency with other error messages in the file.
node_package/src/isServerRenderResult.ts (1)
3-9: LGTM! Type guard implementations are correct.The type guard functions are well-implemented:
isServerRenderHashcorrectly checks for the presence of required propertiesisPromiseproperly verifies the existence of thethenmethodAlso applies to: 12-15
node_package/src/buildConsoleReplay.ts (2)
7-8: LGTM! Interface property formatting is correct.The
Consoleinterface properties are properly formatted according to TypeScript conventions.🧰 Tools
🪛 GitHub Actions: Lint JS and Ruby
[warning] Code style issues found. File needs to be formatted using Prettier.
13-16: LGTM! Function signatures are properly formatted.Both
consoleReplayandbuildConsoleReplayfunctions have their parameters correctly formatted on separate lines, improving readability.Also applies to: 51-58
🧰 Tools
🪛 GitHub Actions: Lint JS and Ruby
[warning] Code style issues found. File needs to be formatted using Prettier.
node_package/src/types/index.ts (3)
32-35: LGTM! Type definitions are properly formatted.The
AuthenticityHeadersandStoreGeneratortypes are correctly formatted according to TypeScript conventions.Also applies to: 37-37
53-65: Documentation improvements enhance code clarity.The added JSDoc comments provide clear explanations and examples for render functions.
Line range hint
83-94: LGTM! Export statement is properly formatted.The type exports are correctly organized and formatted.
.prettierrc (2)
8-8: Updated to use the new Prettier option name.The
jsxBracketSameLineoption has been correctly renamed tobracketSameLineas per Prettier's latest conventions.
11-22: LGTM! Configuration overrides are properly structured.The overrides section is well-organized with:
- Proper formatting for CSS/SCSS files
- JSON file configuration
- New YAML parser for rc files
.prettierignore (2)
16-26: Well-documented ignore entries.The new ignore entries are clearly documented with explanatory comments, making maintenance easier:
- ERB syntax issues in YAML files
- Intentionally invalid test fixtures
- Non-YAML files
- ESLint compatibility issues
13-13: Consider the implications of broadening the generated files pattern.The pattern change from
**/generated/**to**/*generated*will now ignore any file containing "generated" in its path, not just files within a "generated" directory. This could potentially ignore files unintentionally.✅ Verification successful
Pattern change has no current impact but should be documented
The broader pattern
**/*generated*currently doesn't affect any existing files in the codebase. However, it would be helpful to document the intention behind this change to help future maintainers understand which files should be ignored.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Find files that would be newly ignored by the broader pattern fd -t f | grep -P "generated" | grep -vP "/generated/"Length of output: 52
Script:
#!/bin/bash # First verify repository content and both patterns echo "=== Repository files ===" fd -t f | head -n 5 echo -e "\n=== Files matching old pattern (**/generated/**) ===" fd -t f | grep -P "/generated/" echo -e "\n=== Files matching new pattern (**/*generated*) ===" fd -t f | grep -i "generated"Length of output: 469
package-scripts.yml (2)
36-43: Well-structured concurrent formatting setup.The format script has been improved to:
- Run formatters concurrently for better performance
- Use clear naming for each concurrent task
- Separate concerns by file type
54-60: Good addition of TypeScript formatting support.The TypeScript formatting configuration:
- Covers both .ts and .tsx files
- Includes both write and check modes
- Follows the same pattern as other formatters
| export function reactRender(domNode: Element, reactElement: ReactElement): RenderReturnType { | ||
| if (supportsRootApi) { | ||
| const root = reactDomClient.createRoot(domNode); | ||
| root.render(reactElement); | ||
| return root; | ||
| } | ||
|
|
||
| // eslint-disable-next-line react/no-render-return-value | ||
| return ReactDOM.render(reactElement, domNode); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Consider refactoring the legacy render return value usage.
While the code includes an ESLint disable comment, the usage of ReactDOM.render's return value is discouraged as it's a legacy pattern. Future versions of React might return this value asynchronously.
Consider refactoring to avoid depending on the return value:
export function reactRender(domNode: Element, reactElement: ReactElement): RenderReturnType {
if (supportsRootApi) {
const root = reactDomClient.createRoot(domNode);
root.render(reactElement);
return root;
}
- // eslint-disable-next-line react/no-render-return-value
- return ReactDOM.render(reactElement, domNode);
+ ReactDOM.render(reactElement, domNode);
+ // Return null or undefined to indicate legacy mode
+ return null;
}This change would require updating the RenderReturnType to allow null values:
type RenderReturnType = Root | null;🧰 Tools
🪛 Biome (1.9.4)
[error] 38-38: Do not depend on the value returned by the function ReactDOM.render().
The returned value is legacy and future versions of React might return that value asynchronously.
Check the React documentation for more information.
(lint/correctness/noRenderReturnValue)
| run: | | ||
| echo -e "Already installed $(google-chrome --version)\n" | ||
| MINIMUM_REQUIRED_CHROME_VERSION=75 | ||
| INSTALLED_CHROME_MAJOR_VERSION="$(google-chrome --version | tr ' .' '\t' | cut -f3)" | ||
| if [[ $INSTALLED_CHROME_MAJOR_VERSION < $MINIMUM_REQUIRED_CHROME_VERSION ]]; then | ||
| wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add - | ||
| sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' | ||
| sudo apt-get update | ||
| sudo apt-get install google-chrome-stable | ||
| echo -e "\nInstalled $(google-chrome --version)" | ||
| fi |
There was a problem hiding this comment.
Fix numeric comparison in shell script.
Use -lt instead of < for numeric comparisons in shell scripts.
- if [[ $INSTALLED_CHROME_MAJOR_VERSION < $MINIMUM_REQUIRED_CHROME_VERSION ]]; then
+ if [[ $INSTALLED_CHROME_MAJOR_VERSION -lt $MINIMUM_REQUIRED_CHROME_VERSION ]]; then📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| run: | | |
| echo -e "Already installed $(google-chrome --version)\n" | |
| MINIMUM_REQUIRED_CHROME_VERSION=75 | |
| INSTALLED_CHROME_MAJOR_VERSION="$(google-chrome --version | tr ' .' '\t' | cut -f3)" | |
| if [[ $INSTALLED_CHROME_MAJOR_VERSION < $MINIMUM_REQUIRED_CHROME_VERSION ]]; then | |
| wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add - | |
| sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' | |
| sudo apt-get update | |
| sudo apt-get install google-chrome-stable | |
| echo -e "\nInstalled $(google-chrome --version)" | |
| fi | |
| run: | | |
| echo -e "Already installed $(google-chrome --version)\n" | |
| MINIMUM_REQUIRED_CHROME_VERSION=75 | |
| INSTALLED_CHROME_MAJOR_VERSION="$(google-chrome --version | tr ' .' '\t' | cut -f3)" | |
| if [[ $INSTALLED_CHROME_MAJOR_VERSION -lt $MINIMUM_REQUIRED_CHROME_VERSION ]]; then | |
| wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add - | |
| sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' | |
| sudo apt-get update | |
| sudo apt-get install google-chrome-stable | |
| echo -e "\nInstalled $(google-chrome --version)" | |
| fi |
🧰 Tools
🪛 actionlint (1.7.4)
74-74: shellcheck reported issue in this script: SC2071:error:4:39: < is for string comparisons. Use -lt instead
(shellcheck)
.github/workflows/examples.yml
Outdated
| - name: yalc publish for react-on-rails | ||
| run: yalc publish | ||
| - name: Install Ruby Gems for package | ||
| run: bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3 |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve shell script reliability.
The pattern A && B || C can lead to unexpected behavior. Use an explicit if-then-else construct instead.
- run: bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3
+ run: |
+ bundle lock --add-platform 'x86_64-linux'
+ if bundle check --path=vendor/bundle; then
+ echo "Bundle check passed"
+ else
+ bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3
+ fi📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| run: bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3 | |
| run: | | |
| bundle lock --add-platform 'x86_64-linux' | |
| if bundle check --path=vendor/bundle; then | |
| echo "Bundle check passed" | |
| else | |
| bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3 | |
| fi |
🧰 Tools
🪛 actionlint (1.7.4)
72-72: shellcheck reported issue in this script: SC2015:info:1:43: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
package.json
Outdated
| "eslint-config-prettier": "^10.0.1", | ||
| "eslint-config-shakacode": "^16.0.1", | ||
| "eslint-plugin-import": "^2.29.1", | ||
| "eslint-plugin-jsx-a11y": "^6.8.0", | ||
| "eslint-plugin-prettier": "^3.4.1", | ||
| "eslint-plugin-prettier": "^5.2.3", | ||
| "eslint-plugin-react": "^7.33.2", | ||
| "jest": "^29.7.0", | ||
| "jest-environment-jsdom": "^29.7.0", | ||
| "jsdom": "^22.1.0", | ||
| "nps": "^5.9.3", | ||
| "prettier": "^2.8.8", | ||
| "prettier-eslint-cli": "^5.0.0", | ||
| "prettier": "^3.4.2", |
There was a problem hiding this comment.
💡 Codebase verification
Incompatible dependency versions detected
The current eslint version (^7.32.0) is incompatible with eslint-plugin-prettier@5.2.3, which requires eslint >= 8.0.0. You need to:
- Update eslint to version 8 or higher along with these changes
- Or downgrade eslint-plugin-prettier to a version compatible with eslint v7
🔗 Analysis chain
Verify compatibility with major version updates.
The PR includes significant version bumps:
- prettier v2 → v3
- eslint-config-prettier v7 → v10
- eslint-plugin-prettier v3 → v5
These updates may introduce breaking changes.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check for breaking changes and compatibility
echo "Checking prettier changelog for breaking changes..."
curl -s https://raw.githubusercontent.com/prettier/prettier/main/CHANGELOG.md | grep -A 10 "3.0.0"
echo "Verifying peer dependency requirements..."
npm info eslint-config-prettier@10.0.1 peerDependencies
npm info eslint-plugin-prettier@5.2.3 peerDependencies
Length of output: 2812
Script:
#!/bin/bash
# Check eslint version in package.json
echo "Checking eslint version..."
cat package.json | jq '.dependencies.eslint, .devDependencies.eslint'
Length of output: 149
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
2 times, most recently
from
729e94c to
67d4506
Compare
| "eslint-config-shakacode": "^16.0.1", | ||
| "eslint-plugin-import": "^2.29.1", | ||
| "eslint-plugin-jsx-a11y": "^6.8.0", | ||
| "eslint-plugin-prettier": "^3.4.1", | ||
| "eslint-plugin-prettier": "^4.2.1", |
There was a problem hiding this comment.
There is also v5, but it requires ESLint >=8.0.0, and should be updated together with that as part of #1689.
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
from
67d4506 to
bc11297
Compare
| @@ -1,7 +1,6 @@ | |||
| extends: | |||
| - eslint-config-shakacode | |||
| - prettier | |||
| - prettier/react | |||
There was a problem hiding this comment.
Removed in eslint-prettier-config.
| @@ -16,79 +16,79 @@ jobs: | |||
| versions: ['oldest', 'newest'] | |||
| runs-on: ubuntu-22.04 | |||
| steps: | |||
| - uses: actions/checkout@v4 | |||
There was a problem hiding this comment.
You may prefer to hide whitespace while reviewing.
.travis.yml
Outdated
| @@ -31,7 +31,7 @@ before_install: | |||
| - sudo apt-get install -y xvfb libappindicator1 fonts-liberation | |||
| - wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb | |||
| - sudo dpkg -i google-chrome*.deb | |||
| - "/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen scn 1600x1200x16" | |||
| - '/sbin/start-stop-daemon --start --quiet --pidfile /tmp/custom_xvfb_99.pid --make-pidfile --background --exec /usr/bin/Xvfb -- :99 -ac -screen scn 1600x1200x16' | |||
There was a problem hiding this comment.
Should this file be deleted instead?
package.json
Outdated
| "eslint-plugin-react": "^7.33.2", | ||
| "jest": "^29.7.0", | ||
| "jest-environment-jsdom": "^29.7.0", | ||
| "jsdom": "^22.1.0", | ||
| "nps": "^5.9.3", | ||
| "prettier": "^2.8.8", | ||
| "prettier-eslint-cli": "^5.0.0", |
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (3)
.github/workflows/examples.yml (3)
64-64:⚠️ Potential issueUpdate deprecated GitHub Actions command.
The
set-outputcommand is deprecated. Use the newGITHUB_OUTPUTenvironment file approach instead.- run: echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT + run: echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT🧰 Tools
🪛 actionlint (1.7.4)
64-64: shellcheck reported issue in this script: SC2086:info:1:37: Double quote to prevent globbing and word splitting
(shellcheck)
72-72:⚠️ Potential issueImprove shell script reliability.
The pattern
A && B || Ccan lead to unexpected behavior. Use an explicit if-then-else construct instead.- run: bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3 + run: | + bundle lock --add-platform 'x86_64-linux' + if bundle check --path=vendor/bundle; then + echo "Bundle check passed" + else + bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3 + fi🧰 Tools
🪛 actionlint (1.7.4)
72-72: shellcheck reported issue in this script: SC2015:info:1:43: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
74-84:⚠️ Potential issueFix numeric comparison in shell script.
Use
-ltinstead of<for numeric comparisons in shell scripts.- if [[ $INSTALLED_CHROME_MAJOR_VERSION < $MINIMUM_REQUIRED_CHROME_VERSION ]]; then + if [[ $INSTALLED_CHROME_MAJOR_VERSION -lt $MINIMUM_REQUIRED_CHROME_VERSION ]]; then🧰 Tools
🪛 actionlint (1.7.4)
74-74: shellcheck reported issue in this script: SC2071:error:4:39: < is for string comparisons. Use -lt instead
(shellcheck)
🧹 Nitpick comments (3)
.github/workflows/main.yml (1)
174-177: Consider using environment variables for Git configuration.Instead of hardcoding Git user information, consider using environment variables or GitHub Actions context variables.
- git config user.email "you@example.com" - git config user.name "Your Name" + git config user.email "${GITHUB_ACTOR}@users.noreply.github.com" + git config user.name "${GITHUB_ACTOR}"package-scripts.yml (2)
36-43: Fix color configuration for concurrent tasks.The
-c "yellow,magenta"configuration only specifies two colors but there are three concurrent tasks (ts, js, json). This mismatch could affect task output visibility.- -c "yellow,magenta" \ + -c "yellow,magenta,cyan" \
72-73: Improve cross-platform compatibility of cleanup command.The cleanup command
rm -rfmight fail on Windows. Consider using a cross-platform solution.- script: rm -rf packages/vm-renderer/tests/tmp && prettier "**/*.@(json|yaml)" "**/.*rc" --write + script: rimraf packages/vm-renderer/tests/tmp && prettier "**/*.@(json|yaml)" "**/.*rc" --writeMake sure to add
rimrafas a dev dependency if not already present:// package.json { "devDependencies": { + "rimraf": "^5.0.0" } }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (26)
.circleci/config.yml(0 hunks).eslintrc(0 hunks).github/workflows/examples.yml(2 hunks).github/workflows/lint-js-and-ruby.yml(1 hunks).github/workflows/main.yml(2 hunks).github/workflows/package-js-tests.yml(1 hunks).github/workflows/rspec-package-specs.yml(1 hunks).prettierignore(1 hunks).prettierrc(1 hunks).scss-lint.yml(1 hunks).travis.yml(2 hunks)lib/generators/react_on_rails/templates/.eslintrc(1 hunks)lib/generators/react_on_rails/templates/base/base/config/shakapacker.yml(1 hunks)node_package/src/buildConsoleReplay.ts(2 hunks)package-scripts.yml(1 hunks)package.json(1 hunks)rakelib/examples_config.yml(1 hunks)spec/dummy/.prettierignore(0 hunks)spec/dummy/.prettierrc(0 hunks)spec/dummy/client/.eslintrc(0 hunks)spec/dummy/client/.jscsrc(1 hunks)spec/dummy/config/locales/en.yml(1 hunks)spec/dummy/config/shakapacker.yml(1 hunks)spec/dummy/config/storage.yml(0 hunks)spec/react_on_rails/fixtures/i18n/locales/de.yml(1 hunks)spec/react_on_rails/fixtures/i18n/locales/en.yml(1 hunks)
💤 Files with no reviewable changes (6)
- spec/dummy/config/storage.yml
- spec/dummy/.prettierignore
- .eslintrc
- .circleci/config.yml
- spec/dummy/.prettierrc
- spec/dummy/client/.eslintrc
🚧 Files skipped from review as they are similar to previous changes (17)
- spec/dummy/client/.jscsrc
- spec/react_on_rails/fixtures/i18n/locales/de.yml
- lib/generators/react_on_rails/templates/.eslintrc
- .travis.yml
- spec/dummy/config/locales/en.yml
- .github/workflows/rspec-package-specs.yml
- spec/react_on_rails/fixtures/i18n/locales/en.yml
- lib/generators/react_on_rails/templates/base/base/config/shakapacker.yml
- .github/workflows/package-js-tests.yml
- spec/dummy/config/shakapacker.yml
- .scss-lint.yml
- .github/workflows/lint-js-and-ruby.yml
- rakelib/examples_config.yml
- .prettierrc
- package.json
- .prettierignore
- node_package/src/buildConsoleReplay.ts
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/examples.yml
64-64: shellcheck reported issue in this script: SC2086:info:1:37: Double quote to prevent globbing and word splitting
(shellcheck)
72-72: shellcheck reported issue in this script: SC2015:info:1:43: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
74-74: shellcheck reported issue in this script: SC2071:error:4:39: < is for string comparisons. Use -lt instead
(shellcheck)
.github/workflows/main.yml
70-70: shellcheck reported issue in this script: SC2015:info:1:60: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
72-72: shellcheck reported issue in this script: SC2209:warning:1:18: Use var=$(command) to assign output (or quote to assign string)
(shellcheck)
76-76: workflow command "set-output" was deprecated. use echo "{name}={value}" >> $GITHUB_OUTPUT instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions
(deprecated-commands)
136-136: workflow command "set-output" was deprecated. use echo "{name}={value}" >> $GITHUB_OUTPUT instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions
(deprecated-commands)
153-153: shellcheck reported issue in this script: SC2015:info:1:43: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
155-155: shellcheck reported issue in this script: SC2015:info:1:60: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
157-157: shellcheck reported issue in this script: SC2071:error:4:39: < is for string comparisons. Use -lt instead
(shellcheck)
171-171: shellcheck reported issue in this script: SC2209:warning:1:18: Use var=$(command) to assign output (or quote to assign string)
(shellcheck)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: dummy-app-integration-tests (newest)
- GitHub Check: dummy-app-integration-tests (oldest)
- GitHub Check: examples (newest)
- GitHub Check: examples (oldest)
- GitHub Check: rspec-package-tests (oldest)
- GitHub Check: build
🔇 Additional comments (2)
package-scripts.yml (2)
54-60: Well-structured TypeScript formatting configuration!The TypeScript formatting configuration is well-implemented with appropriate glob patterns and formatting options.
63-69: Verify coverage of JavaScript files after glob pattern simplification.The script has been simplified from specific directory patterns to a general glob pattern. Let's verify that all JavaScript files are still covered by the new pattern.
✅ Verification successful
Simplified glob pattern provides better coverage for consistent code formatting
The new pattern
**/*.@(js|jsx)includes additional JavaScript/JSX files that should benefit from consistent formatting:
- Configuration files (jest.config.js, babel.config.js)
- Generator templates
- Test files
- Webpack configuration
- Fixture files
This broader coverage helps maintain consistent code style across all JavaScript files in the project.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Compare old and new glob pattern coverage echo "Files that would be matched by old pattern:" find . -path "*/packages/**/*.js" -o -path "*/packages/**/*.jsx" -o -path "*/spec/dummy/client/app/**/*.js" -o -path "*/spec/dummy/client/app/**/*.jsx" -o -name "webpack.config.babel.js" -o -path "*/webpack/**/*.js" | sort echo -e "\nFiles that would be matched by new pattern:" find . -name "*.js" -o -name "*.jsx" | sort echo -e "\nComparing coverage..." diff <(find . -path "*/packages/**/*.js" -o -path "*/packages/**/*.jsx" -o -path "*/spec/dummy/client/app/**/*.js" -o -path "*/spec/dummy/client/app/**/*.jsx" -o -name "webpack.config.babel.js" -o -path "*/webpack/**/*.js" | sort) <(find . -name "*.js" -o -name "*.jsx" | sort)Length of output: 69903
Script:
#!/bin/bash # Description: Compare old and new glob pattern coverage (excluding node_modules) echo "Files matched by old pattern (excluding node_modules):" find . -path "*/packages/**/*.js" -o -path "*/packages/**/*.jsx" -o -path "*/spec/dummy/client/app/**/*.js" -o -path "*/spec/dummy/client/app/**/*.jsx" -o -name "webpack.config.babel.js" -o -path "*/webpack/**/*.js" | grep -v "node_modules" | sort echo -e "\nFiles matched by new pattern (excluding node_modules):" find . -name "*.js" -o -name "*.jsx" | grep -v "node_modules" | sort echo -e "\nFiles that would be newly included by the simplified pattern:" diff <(find . -path "*/packages/**/*.js" -o -path "*/packages/**/*.jsx" -o -path "*/spec/dummy/client/app/**/*.js" -o -path "*/spec/dummy/client/app/**/*.jsx" -o -name "webpack.config.babel.js" -o -path "*/webpack/**/*.js" | grep -v "node_modules" | sort) <(find . -name "*.js" -o -name "*.jsx" | grep -v "node_modules" | sort) | grep "^>" | sed 's/^> //'Length of output: 11690
.github/workflows/main.yml
Outdated
| path: spec/dummy/vendor/bundle | ||
| key: dummy-app-gem-cache-${{ hashFiles('react_on_rails.gemspec') }}-${{ hashFiles('Gemfile.development_dependencies') }}-${{ matrix.versions }} | ||
| - name: Install Ruby Gems for dummy app | ||
| run: cd spec/dummy && bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3 |
There was a problem hiding this comment.
Improve shell script reliability in multiple locations.
The pattern A && B || C can lead to unexpected behavior in multiple locations. Use explicit if-then-else constructs instead.
# Line 70
- run: cd spec/dummy && bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3
+ run: |
+ cd spec/dummy
+ bundle lock --add-platform 'x86_64-linux'
+ if bundle check --path=vendor/bundle; then
+ echo "Bundle check passed"
+ else
+ bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3
+ fi
# Line 153
- run: bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3
+ run: |
+ bundle lock --add-platform 'x86_64-linux'
+ if bundle check --path=vendor/bundle; then
+ echo "Bundle check passed"
+ else
+ bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3
+ fi
# Line 155
- run: cd spec/dummy && bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3
+ run: |
+ cd spec/dummy
+ bundle lock --add-platform 'x86_64-linux'
+ if bundle check --path=vendor/bundle; then
+ echo "Bundle check passed"
+ else
+ bundle _2.5.9_ install --path=vendor/bundle --jobs=4 --retry=3
+ fiAlso applies to: 153-153, 155-155
🧰 Tools
🪛 actionlint (1.7.4)
70-70: shellcheck reported issue in this script: SC2015:info:1:60: Note that A && B || C is not if-then-else. C may run when A is true
(shellcheck)
.github/workflows/main.yml
Outdated
| - name: Build test bundles for dummy app | ||
| run: cd spec/dummy && rm -rf public/webpack/test && yarn build:rescript && RAILS_ENV=test NODE_ENV=test bin/${{ matrix.versions == 'oldest' && 'web' || 'shaka' }}packer | ||
| - id: get-sha | ||
| run: echo "::set-output name=sha::$(git rev-parse HEAD)" |
There was a problem hiding this comment.
Update deprecated GitHub Actions commands.
The set-output command is deprecated in multiple locations. Use the new GITHUB_OUTPUT environment file approach instead.
# Line 76
- run: echo "::set-output name=sha::$(git rev-parse HEAD)"
+ run: echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
# Line 136
- run: echo "::set-output name=sha::$(git rev-parse HEAD)"
+ run: echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUTAlso applies to: 136-136
🧰 Tools
🪛 actionlint (1.7.4)
76-76: workflow command "set-output" was deprecated. use echo "{name}={value}" >> $GITHUB_OUTPUT instead: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions
(deprecated-commands)
.github/workflows/main.yml
Outdated
| run: | | ||
| echo -e "Already installed $(google-chrome --version)\n" | ||
| MINIMUM_REQUIRED_CHROME_VERSION=75 | ||
| INSTALLED_CHROME_MAJOR_VERSION="$(google-chrome --version | tr ' .' '\t' | cut -f3)" | ||
| if [[ $INSTALLED_CHROME_MAJOR_VERSION < $MINIMUM_REQUIRED_CHROME_VERSION ]]; then | ||
| wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add - | ||
| sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' | ||
| sudo apt-get update | ||
| sudo apt-get install google-chrome-stable | ||
| echo -e "\nInstalled $(google-chrome --version)" | ||
| fi |
There was a problem hiding this comment.
Fix numeric comparison in shell script.
Use -lt instead of < for numeric comparisons in shell scripts.
- if [[ $INSTALLED_CHROME_MAJOR_VERSION < $MINIMUM_REQUIRED_CHROME_VERSION ]]; then
+ if [[ $INSTALLED_CHROME_MAJOR_VERSION -lt $MINIMUM_REQUIRED_CHROME_VERSION ]]; then📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| run: | | |
| echo -e "Already installed $(google-chrome --version)\n" | |
| MINIMUM_REQUIRED_CHROME_VERSION=75 | |
| INSTALLED_CHROME_MAJOR_VERSION="$(google-chrome --version | tr ' .' '\t' | cut -f3)" | |
| if [[ $INSTALLED_CHROME_MAJOR_VERSION < $MINIMUM_REQUIRED_CHROME_VERSION ]]; then | |
| wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add - | |
| sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' | |
| sudo apt-get update | |
| sudo apt-get install google-chrome-stable | |
| echo -e "\nInstalled $(google-chrome --version)" | |
| fi | |
| run: | | |
| echo -e "Already installed $(google-chrome --version)\n" | |
| MINIMUM_REQUIRED_CHROME_VERSION=75 | |
| INSTALLED_CHROME_MAJOR_VERSION="$(google-chrome --version | tr ' .' '\t' | cut -f3)" | |
| if [[ $INSTALLED_CHROME_MAJOR_VERSION -lt $MINIMUM_REQUIRED_CHROME_VERSION ]]; then | |
| wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add - | |
| sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' | |
| sudo apt-get update | |
| sudo apt-get install google-chrome-stable | |
| echo -e "\nInstalled $(google-chrome --version)" | |
| fi |
🧰 Tools
🪛 actionlint (1.7.4)
157-157: shellcheck reported issue in this script: SC2071:error:4:39: < is for string comparisons. Use -lt instead
(shellcheck)
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
2 times, most recently
from
3046259 to
39a04a3
Compare
alexeyr-ci
changed the title
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
from
39a04a3 to
b8937f1
Compare
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
5 times, most recently
from
24d8d57 to
f5b6ac9
Compare
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
🛑 Comments failed to post (14)
docs/contributor-info/linters.md (1)
16-16: 🛠️ Refactor suggestion
ESLint Instruction Refinement.
There is a typographical issue with an extra colon in “eslint::”—please remove one of the colons. Additionally, as with the Rubocop instruction, consider using an alternative to “right” (e.g., “correct” or “appropriate”) to enhance stylistic variety.🧰 Tools
🪛 LanguageTool
[style] ~16-~16: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...` 3. eslint:: Be sure to be in the right directory where you have JS files. ```...(REP_RIGHT)
docs/javascript/server-rendering-tips.md (1)
28-28:
⚠️ Potential issueFix Typo in "setTimeout"
There is a typographical error in the sentence where "setTimout" is mentioned; it should be "setTimeout".Apply the following diff snippet:
- ... did call setTimout. + ... did call setTimeout.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.These methods are polyfilled for server rendering to be no-ops. We log calls to these when in `trace` mode. In the past, some libraries, namely babel-polyfill, did call setTimeout.docs/getting-started.md (1)
199-199:
⚠️ Potential issueFile Extension Notation in I18n Section.
The note "React on Rails provides an option for automatic conversions of Rails*.ymllocale files into*.jsonor_.js_." appears to have a formatting typo with.js. It likely should be*.js` for consistency with the file glob pattern.node_package/src/pageLifecycle.ts (3)
38-38: 🛠️ Refactor suggestion
Refactor Turbo debug message to use a single literal
The current concatenation of two string literals triggers ESLint'sno-useless-concaterror. Refactor this to a single string literal for clarity.- debugTurbolinks('USING TURBO: document added event listeners ' + 'turbo:before-render and turbo:render.'); + debugTurbolinks('USING TURBO: document added event listeners turbo:before-render and turbo:render.');📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.debugTurbolinks('USING TURBO: document added event listeners turbo:before-render and turbo:render.');🧰 Tools
🪛 GitHub Check: build
[failure] 38-38:
Unexpected string concatenation of literals🪛 ESLint
[error] 38-38: Unexpected string concatenation of literals.
(no-useless-concat)
🪛 GitHub Actions: Lint JS and Ruby
[error] 38-38: ESLint: Unexpected string concatenation of literals. (no-useless-concat)
43-46: 🛠️ Refactor suggestion
Simplify debug message in Turbolinks 5 branch
The debug message here is unnecessarily split across multiple concatenated literals. Combine them into one literal to resolve the ESLint warning and improve readability.- debugTurbolinks( - 'USING TURBOLINKS 5: document added event listeners ' + - 'turbolinks:before-render and turbolinks:render.', - ); + debugTurbolinks('USING TURBOLINKS 5: document added event listeners turbolinks:before-render and turbolinks:render.');📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.debugTurbolinks('USING TURBOLINKS 5: document added event listeners turbolinks:before-render and turbolinks:render.');
52-54: 🛠️ Refactor suggestion
Merge Turbolinks 2 debug message string literals
Similar to the other branches, combining the concatenated string into a single literal will resolve the ESLint error and produce cleaner code.- debugTurbolinks( - 'USING TURBOLINKS 2: document added event listeners page:before-unload and ' + 'page:change.', - ); + debugTurbolinks('USING TURBOLINKS 2: document added event listeners page:before-unload and page:change.');📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.debugTurbolinks('USING TURBOLINKS 2: document added event listeners page:before-unload and page:change.'); document.addEventListener('page:before-unload', runPageUnloadedCallbacks);🧰 Tools
🪛 GitHub Check: build
[failure] 52-52:
Unexpected string concatenation of literals🪛 ESLint
[error] 52-52: Unexpected string concatenation of literals.
(no-useless-concat)
docs/additional-details/recommended-project-structure.md (2)
72-73: 🛠️ Refactor suggestion
Grammar Correction: CSS Modules Description
The text on line 73 contains the phrase “which is super compelling once you seen the benefits.” This should be corrected for proper grammar. For example:
"which is super compelling once you see the benefits"
Correcting “seen” to “see” will improve clarity.
🧰 Tools
🪛 LanguageTool
[grammar] ~73-~73: A verb (‘be’ or ‘have’) is missing before the past participle.
Context: ...es), which is super compelling once you seen the benefits. 1. You can use CSS in JS....(PRP_PAST_PART)
55-56: 🛠️ Refactor suggestion
Grammar & Clarity: Rails Asset Handling Description
The sentence on line 56:
"Your Rails layouts just doing the styling the standard Rails way."
is grammatically incorrect and unclear. Consider revising it to something like:
-Your Rails layouts just doing the styling the standard Rails way. +Your Rails layouts continue to handle styling using standard Rails tools.This revision clarifies the intent and improves grammatical correctness.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.This isn't really any technique, as you keep handling all your styling assets using Rails standard tools, such as using the [sass-rails gem](https://rubygems.org/gems/sass-rails/versions/5.0.4). Basically, Webpack doesn't get involved with styling. Your Rails layouts continue to handle styling using standard Rails tools.🧰 Tools
🪛 LanguageTool
[uncategorized] ~56-~56: Possible missing comma found.
Context: ...t get involved with styling. Your Rails layouts just doing the styling the standard Rai...(AI_HYDRA_LEO_MISSING_COMMA)
docs/release-notes/15.0.0.md (1)
27-34:
⚠️ Potential issueAddress grammatical and stylistic issues in Component Hydration Changes
Several points need attention in this segment:
Hyphenation suggestion (Line 28):
Consider hyphenating “page load” to “full‑page load” if intended as a compound adjective.
Proposed diff:- The `defer_generated_component_packs` and `force_load` configurations now default to `false` and `true` respectively. This means components will hydrate early without waiting for the full page load. This improves performance by eliminating unnecessary delays in hydration. + The `defer_generated_component_packs` and `force_load` configurations now default to `false` and `true` respectively. This means components will hydrate early without waiting for the full-page load. This improves performance by eliminating unnecessary delays in hydration.Verb agreement (Line 31):
Change “configuration make” to “configuration makes”.
Proposed diff:- - The `force_load` configuration make `react-on-rails` hydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load. + - The `force_load` configuration makes `react-on-rails` hydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load.Rephrasing for variation (Line 33):
The phrase “If we want to keep the original behavior…” is repeated; consider rewording for variety.
Suggested revision:- - If we want to keep the original behavior of `force_load` for only one or more components, you can set `force_load: false` in the `react_component` helper or `force_load` configuration. + - Alternatively, if you wish to preserve the original behavior of `force_load` for select components, set `force_load: false` in the `react_component` helper or configuration.Redux store support wording (Line 34):
The sentence is a bit awkward. Consider revising it for clarity and grammatical correctness, including adding a comma before “and”.
Proposed diff:- - Redux store support `force_load` option now and it uses `config.force_load` value as the default value. Which means that the redux store will hydrate immediately as soon as its server-side data reaches the client. You can override this behavior for individual redux stores by setting `force_load: false` in the `redux_store` helper. + - Redux store support for the `force_load` option now uses the `config.force_load` value as its default, meaning that the redux store will hydrate immediately as soon as its server-side data reaches the client. You can override this behavior for individual redux stores by setting `force_load: false` in the `redux_store` helper.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.- The `defer_generated_component_packs` and `force_load` configurations now default to `false` and `true` respectively. This means components will hydrate early without waiting for the full-page load. This improves performance by eliminating unnecessary delays in hydration. - The previous need for deferring scripts to prevent race conditions has been eliminated due to improved hydration handling. Making scripts not defer is critical to execute the hydration scripts early before the page is fully loaded. - The `force_load` configuration makes `react-on-rails` hydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load. - If you want to keep the previous behavior, you can set `defer_generated_component_packs: true` or `force_load: false` in your `config/initializers/react_on_rails.rb` file. - Alternatively, if you wish to preserve the original behavior of `force_load` for select components, set `force_load: false` in the `react_component` helper or configuration. - Redux store support for the `force_load` option now uses the `config.force_load` value as its default, meaning that the redux store will hydrate immediately as soon as its server-side data reaches the client. You can override this behavior for individual redux stores by setting `force_load: false` in the `redux_store` helper.🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...l hydrate early without waiting for the full page load. This improves performance by elim...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ded. - Theforce_loadconfiguration makereact-on-railshydrate components imm...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...hes the client, without waiting for the full page load. - If you want to keep the previ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...zers/react_on_rails.rbfile. - If we want to keep the original behavior offorce_lo...(REP_WANT_TO_VB)
[uncategorized] ~34-~34: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ce_loadconfiguration. - Redux store supportforce_loadoption now and it usesco...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~34-~34: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ux store supportforce_loadoption now and it usesconfig.force_loadvalue as th...(COMMA_COMPOUND_SENTENCE)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (1)
90-95:
⚠️ Potential issueFix Export Typo in Babel Config
The code block usesmodule.exportwhich is likely a typo; it should bemodule.exportsso that Node.js correctly processes the export.Apply the following diff:
-module.export = function(api) { +module.exports = function(api) {📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.module.exports = function(api) { return { plugins: [process.env.WEBPACK_DEV_SERVER && 'react-refresh/babel'].filter(Boolean) } }docs/guides/upgrading-react-on-rails.md (4)
72-74:
⚠️ Potential issueReview Arrow Function Object Literal Syntax.
The example for registered objects uses an arrow function with a block body that appears to construct an object literal but lacks an explicitreturnstatement or parentheses. This might lead to confusion—please consider revising the syntax for clarity.
77-83:
⚠️ Potential issueEnsure Correct Syntax in Two-Argument Function Example.
The snippet demonstrates a function with two parameters that is meant to return an object. Make sure the object literal is properly returned (e.g., by including areturnstatement or wrapping the literal in parentheses) so that readers can accurately implement this pattern.
88-90:
⚠️ Potential issueValidate JSX Syntax in Component Registration Example.
The provided snippet uses double curly braces in<Component {{...props, railsContext}} />, which is non-standard in JSX. Verify whether this is intentional or if it should be corrected to a single set of curly braces.
103-105:
⚠️ Potential issueFix JSX Syntax Error in Broken Component Example.
This “broken” example shows a component export with syntactical issues (extra braces and a missing closing tag). A revision is needed so that the snippet accurately reflects the intended error condition—and ideally, its correction.
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
from
f5b6ac9 to
7abc6b2
Compare
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
🛑 Comments failed to post (2)
docs/rails/turbolinks.md (1)
44-46: 🛠️ Refactor suggestion
Improve Grammar and Clarity in “More Information” Section.
There are several grammatical issues along with subject–verb agreement to address:
- For the first bullet, consider a rephrase such as:
“CSRF tokens require thorough verification with Turbolinks5. Turbolinks5 modifies the head element via JavaScript (not only the body) on page changes to include the correct CSRF meta tag. However, if the JS code parses this from the head when several windows are open, some tests might fail. Although I haven’t examined the details, this issue may be related to application code rather than the library. Additional checks might be needed since the CSRF helper in ReactOnRails must work with Turbolinks5.”
- In the second bullet, change “Turbolinks5 send requests” to “Turbolinks5 sends requests” to ensure proper subject–verb agreement.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...he head element by JavaScript (not only body) on page changes with the correct csrf ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...ag, but if the JS code parsed this from head when several windows were opened, then ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~44-~44: Consider inserting a comma before ‘however’.
Context: ...ecs were not all passing. I didn't look details however, may be it is app code related, not libr...(HOWEVER_MISSING_COMMA)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ... is app code related, not library code. Anyway it may need additional check because th...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~44-~44: You might be missing the article “a” here.
Context: ... need additional check because there is CSRF helper in ReactOnRails and it need to w...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Tur...(COMMA_COMPOUND_SENTENCE)
[grammar] ~44-~44: The pronoun ‘it’ requires a third-person verb or a past tense.
Context: ...e is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Turbolinks5...(HE_NEED)
[uncategorized] ~45-~45: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...to work with Turbolinks5. - Turbolinks5 send requests without theAccept: */*in t...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
docs/guides/upgrading-react-on-rails.md (1)
103-106:
⚠️ Potential issueAttention Required: Syntax Issue in Example
The code example (lines 103–106) intended to demonstrate a broken pattern has a syntax error in its JSX (an extra or missing curly bracket). Please verify and correct the snippet so it accurately illustrates the intended mistake.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (139)
docs/testimonials/resortpass.md (1)
3-3: Refine Testimonial Text: Adjust Grammar & Enhance ReadabilityThe merged paragraph at line 3 improves consistency in formatting, but it now forms a dense block of text that might affect readability. In addition, please update "react on rails application" to "React on Rails application" since "React" is a proper noun. Lastly, as suggested by the static analysis hint, consider using a stronger adjective (e.g., "profound") instead of "deep" to better capture the intended emphasis.
🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Consider an alternative adjective to strengthen your wording.
Context: ...ted code that both works and reflects a deep understanding of the technologies and p...(DEEP_PROFOUND)
[grammar] ~3-~3: “React” is a proper noun and needs to be capitalized.
Context: ...s and standards for our transition to a react on rails application. Just three months...(A_GOOGLE)
docs/deployment/elastic-beanstalk.md (2)
45-45: Nitpick: Ensure consistent capitalization for framework and technology names.In this line, consider updating:
"rails"to"Rails"(referring to Ruby on Rails)."node.js"to"Node.js"(to match the official branding).Minor adjustments like these enhance consistency in documentation.
47-47: Nitpick: Capitalize proper nouns in the deployment note.Please update this line by:
- Changing
"react"to"React".- Changing
"javascript"to"JavaScript".- Optionally, consider capitalizing
"elastic beanstalk"to"Elastic Beanstalk"for consistency with the document title.These changes will help maintain a professional presentation throughout the document.
🧰 Tools
🪛 LanguageTool
[grammar] ~47-~47: “React” is a proper noun and needs to be capitalized.
Context: ...ic beanstalk successfully. However, the react app javascript files are under `public/...(A_GOOGLE)
docs/javascript/webpack-v1-notes.md (1)
7-7: Nitpick: Tweak Punctuation and Tone in the--bailExplanation.
The new sentence at line 7 uses an exclamation mark ("Webpack cannot complete!") which might be overly emphatic for a technical document. Additionally, the clause beginning with “and you want to see all the errors…” would read more cleanly with a comma before "and" to separate the independent clauses.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1166 characters long)
Context: ...ment halt if Webpack cannot complete! For more details, see the documentation...(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~7-~7: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Webpack returning a non-zero error code and you want to see all the errors, rather ...(COMMA_COMPOUND_SENTENCE)
docs/outdated/rails3.md (2)
3-3: Enhance the Wording for ClarityThe revised line now reads:
- Please let us know if you find any issues with Rails 3.Consider replacing "let us know" with a more direct verb (e.g., "notify" or "inform") to strengthen the directive. For instance:
- Please let us know if you find any issues with Rails 3. + Please notify us if you encounter any issues with Rails 3.[style]
🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Consider using a different verb to strengthen your wording.
Context: # Rails 3 - Please let us know if you find any issues with Rails 3. - Rails 3 is c...(FIND_ENCOUNTER)
5-5: Revise the Verbage for a Stronger Call-to-ActionThe current version:
- We are not testing it for new releases. If you find an issue, you will have to submit a PR to get it fixed.could be improved by using more assertive language. For example:
- We are not testing it for new releases. If you find an issue, you will have to submit a PR to get it fixed. + We are not currently testing new releases. If you encounter an issue, please open a pull request to address it.This adjustment makes the statement more direct and professional.
[style]🧰 Tools
🪛 LanguageTool
[style] ~5-~5: Consider using a different verb to strengthen your wording.
Context: ...not testing it for new releases. If you find an issue, you will have to submit a PR ...(FIND_ENCOUNTER)
docs/api/view-helpers-api.md (1)
98-100: Stylistic Suggestion: Compound Adjective HyphenationIn the sentence on lines 98–100, the phrases "server side" and "client side" are used as compound adjectives modifying "rails_context." For enhanced clarity and consistency, consider hyphenating them as "server-side" and "client-side."
For example, you might update:
- Pass true or false depending on whether you want to see the server side or the client side rails_context. + Pass true or false depending on whether you want to see the server-side or the client-side rails_context.🧰 Tools
🪛 LanguageTool
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... you want to see the server side or the client side rails_context. Typically, for computing...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/react-and-redux.md (3)
4-6: Format Bare URL in Documentation
The URL on line 5 is provided in bare format, which can trigger markdown linting warnings (MD034). It is recommended to format it as a proper markdown link for better readability and compliance.[minor_nitpick]
-See https://facebook.github.io/react/tips/communicate-between-components.html +See [React Communication Tips](https://facebook.github.io/react/tips/communicate-between-components.html)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Bare URL used
null(MD034, no-bare-urls)
7-10: Clarify Redux Reducers Documentation
The added line "Documentation of generated Redux code for reducers." provides additional context; however, consider expanding this section with further details or a reference link to guide readers toward more comprehensive documentation.
11-14: Enhance Reducer Example Introduction
The introductory note for the reducer example clearly explains why a more fleshed-out example follows. Optionally, a brief summary of the key enhancements could further assist readers in understanding the improvements over the simpler version.docs/rails/rails-engine-integration.md (1)
35-38: Improve Grammar in GitHub Issues List EntryIn the GitHub issues list, the entry:
- [Feature: target destination option for the install generator #459](https://github.com/shakacode/react_on_rails/issues/459)
contains the phrase “install generator.” Since “install” is not conventionally used as a noun, consider changing it to “installation generator” for improved grammatical correctness.Apply this diff:
- [Feature: target destination option for the install generator #459](https://github.com/shakacode/react_on_rails/issues/459) + [Feature: target destination option for the installation generator #459](https://github.com/shakacode/react_on_rails/issues/459)🧰 Tools
🪛 LanguageTool
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...ture: target destination option for the install generator #459](https://github.com/shak...(A_INSTALL)
docs/misc/tips.md (6)
3-3: Clarify Command Instruction
The line instructs not to runrails sand instead use the foreman command. Consider adding a brief explanation of why this approach is preferred (e.g., to ensure that webpack watchers are automatically started), which can help readers understand the recommendation.
7-7: Enhance Readability
This sentence is quite lengthy. Consider breaking it into shorter segments or bullet points to help readers quickly grasp the implications (e.g., the need to rebuild bundles when tests are run).
9-9: Technical Term Hyphenation
Please change “server side rendering” to “server‑side rendering” for clarity and consistency. Also, consider replacing “right now” with “currently” to maintain a more formal tone.🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ht now isprerender: false. NOTE: Server side rendering does not work for some compon...(EN_COMPOUND_ADJECTIVE_INTERNAL)
10-10: Clarify Component Exposure Description
The phrase “rather than simply props” is ambiguous. Please rephrase or elaborate on the intended distinction between creating a React component via a function and other approaches.
11-11: Correct Terminology and Capitalization
Change “react component client only” to “React component client‑side only” to ensure proper capitalization and clarity.🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: “React” is a proper noun and needs to be capitalized.
Context: ...nt. - Be sure you can first render your react component client only before you tr...(A_GOOGLE)
12-12: Consistent Rendering Terminology
Please replace “server rendering” with “server‑side rendering” throughout the text, and ensure that “react” is consistently capitalized as “React” when referring to components.docs/additional-details/manual-installation-overview.md (2)
3-5: Verify Removal of Extra Blank Line.
The PR objectives mentioned removing a blank line between the "TODO: Review this file" line and the subsequent descriptive line. However, the file still contains an empty line at line 4. Please confirm whether this extra blank line should be removed to fully adhere to the intended formatting improvements.
21-22: Enhance Grammar and Punctuation in Gem Instruction.
The formatting change correctly removed extra spacing before the "Addgem "webpacker"..." text. Additionally, consider revising the sentence for improved clarity by:
- Using the plural verb ("are used") instead of "is used" since it refers to both
stylesheet_pack_tagandjavascript_pack_tag.- Introducing a comma after the helper names before the relative clause.
A suggested diff for clarity is provided below:
-1. Add `gem "webpacker"` to the Gemfile, run bundle. The gem provides the `stylesheet_pack_tag` and `javascript_pack_tag` helpers which is used to load the bundled assets to your layouts.[Dummy Example](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/app/views/layouts/application.html.erb) +1. Add `gem "webpacker"` to the Gemfile, run bundle. The gem provides the `stylesheet_pack_tag` and `javascript_pack_tag` helpers, which are used to load the bundled assets to your layouts, [Dummy Example](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/app/views/layouts/application.html.erb)This refinement will improve grammatical accuracy and readability.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...eet_pack_tagandjavascript_pack_tag` helpers which is used to load the bundled asset...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...andjavascript_pack_taghelpers which is used to load the bundled assets to your...(AI_HYDRA_LEO_CPT_IS_ARE)
docs/contributor-info/linters.md (6)
10-11: Clarify RuboCop Directory Instruction
The RuboCop instruction now clearly advises being in the correct directory with Ruby files. Consider replacing "in the right directory" with "in the correct directory" for stylistic variety and clarity.
16-16: Remove Extra Colon in ESLint Instruction
There is an extra colon in the ESLint instruction ("eslint::") on line 16. Removing the additional colon will improve clarity.
Proposed change:-3. **eslint:**: Be sure to be in the right directory where you have JS files. +3. **eslint:** Be sure to be in the right directory where you have JS files.🧰 Tools
🪛 LanguageTool
[style] ~16-~16: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...` 3. eslint:: Be sure to be in the right directory where you have JS files. ```...(REP_RIGHT)
12-14: Add Language Specifier to RuboCop Command Code Block
For consistency with markdownlint recommendations and to improve syntax highlighting, add a language identifier (e.g.,bash) to this fenced code block.
Proposed diff:-``` -rubocop -a -``` +```bash +rubocop -a +```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
12-12: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
18-20: Specify Language for ESLint Command Code Block
Similar to the RuboCop code block, please add a language specifier (such asbash) to the ESLint command block for enhanced readability.
Proposed diff:-``` -eslint --fix . -``` +```bash +eslint --fix . +```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
18-18: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
24-26: Include Language Identifier in NPM Lint Command Code Block
The fenced code block for the npm lint command would benefit from having a language specifier (e.g.,bash), which also resolves markdownlint warnings.
Proposed diff:-``` -npm run lint -- --fix -``` +```bash +npm run lint -- --fix +```🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
24-24: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
68-71: Review Useful Reference Links List
The bullet list for "Useful Reference Links" is now neatly formatted. As a minor note, verify that both ESLint-related links ("Configuring ESLint" and "ESLint quick start") are intentionally included and not redundant.🧰 Tools
🪛 LanguageTool
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ... Useful Reference Links - Configuring ESLint - [ESLint quick start](http://untilfalse.com/esli...(ENGLISH_WORD_REPEAT_RULE)
docs/javascript/server-rendering-tips.md (4)
5-13: Enhanced Readability in the "General Tips" Section.
The spacing and formatting adjustments in this section improve readability and clarity. As a nitpick, consider hyphenating compound adjectives where applicable (e.g., use server-side instead of "Server side") to maintain consistency with common style practices.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Your code can't referencedocument. Server side JS execution does not have access to `d...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~12-~12: Possible missing preposition found.
Context: ...s defined or using the "railsContext" your top level react component. Since the pa...(AI_HYDRA_LEO_MISSING_OF)
[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...the view helper applies to client and server side code, the best way to do this is to use...(EN_COMPOUND_ADJECTIVE_INTERNAL)
22-24: Consistent Formatting for the CSS Section Header.
The changes in the "CSS" section—specifically the spacing adjustments—make the documentation more uniform and easier to scan.
26-30: Typographical Error and Punctuation in the Timer Functions Section.
The formatting in the "setTimeout, setInterval, and clearTimeout" section is now more uniform. However, note that within the sentence ("In the past, some libraries, namely babel-polyfill, did call setTimout."), setTimout appears to be a typo and should likely be setTimeout. Additionally, consider reviewing the punctuation for clarity as suggested by static analysis.🧰 Tools
🪛 LanguageTool
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...d call setTimout. Here's an example of this which shows the line numbers that end u...(AI_HYDRA_LEO_MISSING_COMMA)
31-35: Improved Layout of Example Command Blocks.
The formatting changes in the example command block (including changes on lines 31 and 34) enhance the presentation and readability of the sample commands, making them clearer for users to follow.CHANGELOG.md (7)
452-475: Consistent Heading Levels
Markdownlint (MD001) reports that some headings increase by more than one level at a time in this section. For example, a jump from an H3 to an H5 makes the document structure harder to follow. Please review and adjust these headings so that they increment by only one level at a time (e.g. H3 → H4, then H4 → H5 if needed).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
452-452: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
1433-1470: Specify a Language for Fenced Code Blocks
Several fenced code blocks in this section (e.g. around lines 1433, 1452, 1461, and 1467) do not specify a language, which can hinder proper syntax highlighting in markdown renderers. Please add an appropriate language identifier (for example, useshellif the block contains shell commands or another fitting language) to improve clarity and consistency.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1433-1433: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
1440-1440: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
1452-1452: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
1461-1461: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
1467-1467: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
427-428: Unordered List Marker Consistency
Markdownlint (MD004) advises using dashes (-) for unordered list items rather than asterisks. In these lines, the asterisk is used, which may be inconsistent with the project’s preferred style. Please update these to use dashes to ensure style consistency throughout the document.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
427-427: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
428-428: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
617-617: Bare URL Usage
A bare URL is used on this line (MD034). It’s best practice to either wrap the URL in angle brackets or format it as a proper markdown link so that it renders consistently across different markdown processors.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
617-617: Bare URL used
null(MD034, no-bare-urls)
798-798: Bare URL Usage
This line also includes a bare URL (MD034). Consider formatting it as a clickable markdown link (e.g.[link text](https://example.com)) for improved readability and to conform with markdown style guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
798-798: Bare URL used
null(MD034, no-bare-urls)
899-899: Bare URL Usage
Avoid using bare URLs (MD034) in the changelog. Formatting them as proper markdown links will help maintain a consistent style and improve readability of the document.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
899-899: Bare URL used
null(MD034, no-bare-urls)
745-745: Link Text Formatting
There appears to be an issue with spaces being used inside link text on this line (MD039). Please remove the extra spaces inside the link text so that it adheres to the markdown style guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
745-745: Spaces inside link text
null(MD039, no-space-in-links)
docs/misc/style.md (3)
23-26: Refined Formatting in JavaScript Coding StandardsThe added spacing and bullet points in this section clearly outline the resources.
Minor Note: The term “Javascript” on line 24 could be standardized to “JavaScript” to match common usage.
33-35: Enhanced Structure in Sass Coding StandardsThe formatting improvements here—with the blank line and bullet points—add clarity.
Minor Note: Consider capitalizing “Github” as “GitHub” (line 35) for consistency with the official branding.
38-41: Improved Formatting and Clarity in Git UsageThe inclusion of a blank line and well-structured bullet points provides better guidance.
Stylistic Suggestion: The phrase “branch off of master” (line 39) is a bit wordy. Replacing it with “branch from master” would be more concise.🧰 Tools
🪛 LanguageTool
[style] ~39-~39: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...ow a github-flow model where you branch off of master for features. - Before merging a...(EN_WORDINESS_PREMIUM_OFF_OF)
docs/additional-details/recommended-project-structure.md (4)
50-50: Stylistic Enhancement:
Consider revising “Here's a good discussion of this option” to a more emphatic phrase (e.g., “Here's a detailed discussion of this option”) to reinforce the value of the linked resource.🧰 Tools
🪛 LanguageTool
[style] ~50-~50: Consider an alternative adjective to strengthen your wording.
Context: ...s asset pipeline. It depends! Here's a good discussion of this option: [Why does Ra...(GOOD_CONSTRUCTIVE)
55-56: Clarify Explanation for Simple Rails Way:
The phrasing “This isn't really any technique” might confuse readers. It may be clearer to reword it as “This approach is not a distinct technique” or a similar phrasing to better convey that it’s simply the default Rails method.
59-60: Grammar Suggestion:
The sentence “Much simpler! There's no changes really from your current processes” would be clearer as “Much simpler! There are no significant changes from your current processes.” This improves grammatical correctness and clarity.
[grammar]🧰 Tools
🪛 LanguageTool
[grammar] ~60-~60: Did you mean “There are no changes”?
Context: ... the Simple Rails Way 1. Much simpler! There's no changes really from your current processes. ##...(THERE_S_MANY)
68-68: Punctuation Consistency:
Consider refining the punctuation in the list item (e.g., “/client/app/assets: Assets for CSS for client app”) to ensure consistency and clarity, such as by standardizing the separation between the file path and its description.🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ctory structure 1./client/app/assets: Assets for CSS for client app. 1. `/cli...(UNLIKELY_OPENING_PUNCTUATION)
docs/outdated/rails-assets-relative-paths.md (2)
1-1: Formatting: Bold Italics for the Introductory Note
It appears the introductory note is still using simple italics (with underscores). According to the PR description, this note should be reformatted to bold italics. Consider using triple asterisks (e.g.,***Note: ...***) instead of underscores to achieve the intended style.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1-1: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
67-67: Stylistic Suggestion: Punctuation in Abbreviations
The text describes file extensions as "(.png, .jpg, etc)". For correct American English style, consider ensuring that abbreviations like "etc." are properly punctuated inside the closing punctuation—this could be adjusted from "etc)" to "etc.)".🧰 Tools
🪛 LanguageTool
[style] ~67-~67: In American English, abbreviations like “etc.” require a period.
Context: ...nsion of the original file (.png, .jpg, etc). Next we'll set the outputPath for ou...(ETC_PERIOD)
docs/javascript/capistrano-deployment.md (6)
2-2: Whitespace Improvement after HeaderAn extra newline has been added immediately after the header, which improves the overall readability of the document.
3-3: Consider Adding a Determiner for ClarityThe sentence "Make sure ReactOnRails is working in development environment." could be clearer by adding an article. For example, consider "Make sure ReactOnRails is working in the development environment."
🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: ...t Make sure ReactOnRails is working in development environment. Add the following to deve...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
6-6: Improved Visual SeparationAn extra blank line has been introduced after the instruction on updating the Gemfile. This helps to visually separate the textual instruction from the subsequent code block.
12-12: Additional Spacing for ReadabilityAn extra newline after the Ruby code block creates a clear visual break between sections, enhancing overall readability.
20-20: Improved Section DelimitationAn extra newline inserted before the Capfile instruction helps demarcate the successive sections clearly.
24-24: Clear Separation After Code BlockThe extra newline after the Ruby code block in the Capfile segment enhances readability by separating it from the subsequent content.
docs/additional-details/generator-details.md (3)
43-44: Enhance clarity and style in the client code organization description.
The sentence “Each unique set of functionality, is given its own folder inside ofapp/javascript/app/bundles” includes an unnecessary comma and the phrase “inside of” can be simplified to “in.” Moreover, “This encourages for modularity of domains” is a bit awkward; consider rephrasing it to “This promotes modularity of domains” (or “across domains”) for improved readability and conciseness.Suggested diff:
-The generated client code follows our organization scheme. Each unique set of functionality, is given its own folder inside of `app/javascript/app/bundles`. Note, the recommended for bigger projects is `client/app/bundles`. This encourages for modularity of _domains_. +The generated client code follows our organization scheme. Each unique set of functionality is given its own folder in `app/javascript/app/bundles`. Note that for larger projects, the recommended structure is `client/app/bundles`. This promotes modularity of _domains_.🧰 Tools
🪛 LanguageTool
[style] ~44-~44: This phrase is redundant. Consider using “inside”.
Context: ... functionality, is given its own folder inside ofapp/javascript/app/bundles. Note, the...(OUTSIDE_OF)
48-50: Improve consistency in bullet list formatting.
The bullet points describing the folder contents can be refined for consistency and clarity. For example, avoid loose punctuation and ensure that each bullet follows a similar tone and structure.Suggested diff:
-- `startup`: This contains the entry point files for webpack. It defaults to a single file that is used for server and client compilation, but if these need to be different, then you can create two webpack configurations with separate endpoints. -- `containers`: "smart components" (components that have functionality and logic that is passed to child "dumb components"). -- `components`: includes "dumb components", or components that simply render their properties and call functions given to them as properties by a parent component. Ultimately, at least one of these dumb components will have a parent container component. +- `startup`: Contains the entry point files for webpack. It defaults to a single file used for both server and client compilation; if needed, you can create two webpack configurations with separate endpoints. +- `containers`: Represents "smart components" — components that encapsulate functionality and pass logic to child "dumb components". +- `components`: Includes "dumb components" that simply render provided properties and invoke functions handed down from a parent component, ensuring that at least one serves as a container.🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...find the following folders: -startup: This contains the entry point files for...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ... with separate endpoints. -containers: "smart components" (components that hav...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...child "dumb components"). -components: includes "dumb components", or componen...(UNLIKELY_OPENING_PUNCTUATION)
58-58: Fix possessive grammar for Redux store.
Replace “it's” with “its” in “each bundle will have it's own Redux store” to correctly denote possession.Suggested diff:
-each bundle will have it's own Redux store. +each bundle will have its own Redux store.🧰 Tools
🪛 LanguageTool
[uncategorized] ~58-~58: Did you mean “its” (the possessive pronoun)?
Context: ...e concept is that each bundle will have it's own Redux store. If you have code that ...(ITS_PREMIUM)
docs/guides/i18n.md (3)
29-34: Improve Grammar and Clarity in Linting NoteThe note explaining that linting will fail if translations are not built is useful. However, consider rephrasing the sentence for improved grammar. For example:
-Note: if you try to lint before running tests, and you depend on the test helper to build your locales, linting will fail because the translations won't be built yet. +Note: if you attempt to lint before running tests and rely on the test helper to build your locales, linting may fail because the translations have not been built yet.This ensures clarity and grammatical correctness.
🧰 Tools
🪛 LanguageTool
[grammar] ~29-~29: Normally, after “try to” a verb is expected.
Context: ...k process as well. Note: if you try to lint before running tests, and you depend on...(WANT_TO_NN)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...he translations before running the lint command or 2. to run the tests first. 4. If...(AI_HYDRA_LEO_MISSING_COMMA)
62-82: Typo in Comment: Correct "Initizalize" to "Initialize"Within the JavaScript code block, the comment “// Initizalize all locales for react-intl.” contains a typo. Please update the comment to use "Initialize" as shown below:
- // Initizalize all locales for react-intl. + // Initialize all locales for react-intl.This will enhance readability and maintain consistency.
93-97: Notes Section is InformativeThe bullet points in the Notes section effectively provide additional context and external references. Consider a brief review of punctuation and any outdated references, updating them if necessary to keep the documentation current.
docs/guides/file-system-based-automated-bundle-generation.md (4)
20-22: Clear Description for Components SubdirectoryThe "Configure Components Subdirectory" section clearly describes the purpose of the
components_subdirectorysetting. As a minor refinement, ensure that phrases like "For example," include proper punctuation for optimal readability.
180-187: Clear Code Example for Component RegistrationThe ERB code block that illustrates component registration is clear and instructive. One minor suggestion: if a textual explanation uses "For example" without a comma (e.g., "For example you can have..."), consider inserting a comma ("For example, you can have...") for better grammatical clarity.
🧰 Tools
🪛 LanguageTool
[typographical] ~180-~180: After the expression ‘for example’ a comma is usually used.
Context: ...ry` nor directly add their bundles. For example you can have a Rails view using three c...(COMMA_FOR_EXAMPLE)
205-207: Consider Simplifying WordingThe description in the "Server Rendering and Client Rendering Components" section—especially the long sentence starting on line 207—is a bit wordy. Consider revising it for brevity and clarity.
🧰 Tools
🪛 LanguageTool
[style] ~207-~207: Consider a shorter alternative to avoid wordiness.
Context: ...ge both in server and client rendering. In order to have separate definitions for client an...(IN_ORDER_TO_PREMIUM)
163-177: Specify Language for Directory Structure Code BlockFor the directory structure example (fenced code block), it's recommended to specify a language (e.g.,
plaintextortext). This adheres to markdown best practices and can improve syntax highlighting in some editors.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
163-163: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
NEWS.md (8)
8-10: Grammar: Verb Form in "setup" Usage
In the August 2, 2020 entry, the phrase “a new way to setup the creation…” should use the verb form “set up” instead, since “setup” is a noun. Consider revising this to “a new way to set up the creation of your SSR bundle…” for grammatical accuracy.🧰 Tools
🪛 LanguageTool
[grammar] ~10-~10: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `r...(NOUN_VERB_CONFUSION)
12-16: Styling: Compound Adjective and Proper Noun Capitalization
In the July 8, 2020 entry, the list item “React Hooks Support for top level components” would be clearer if “top level” is hyphenated to “top‑level”. Also, consider updating “Typescript bindings” to “TypeScript bindings” to reflect standard capitalization.🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v12**. 1. React Hooks Support for top level components 2. Typescript bindings...(EN_COMPOUND_ADJECTIVE_INTERNAL)
20-20: Grammar: Missing Determiner in Breaking Change Notice
The 2017-04-25 entry states “Only 'breaking' change is that you have to update both the node module and the Ruby gem.” Inserting a determiner (e.g., “the only breaking change…”) will clarify the message.🧰 Tools
🪛 LanguageTool
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ...rformance improvements! Please upgrade! Only "breaking" change is that you have to u...(AI_EN_LECTOR_MISSING_DETERMINER)
37-37: Punctuation: Clarify Fix Description
In the 2016-06-06 entry, the sentence “6.0.2 shipped with a critical fix if you are fragment caching the server generated React.” could benefit from added punctuation or hyphenation. For example, adding a comma after “fragment caching” or converting “server generated” to “server‑generated” can enhance clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...with a critical fix if you are fragment caching the server generated React. - 2016-05-2...(AI_HYDRA_LEO_MISSING_COMMA)
48-48: Grammar: Missing Preposition in Projects Page Entry
The sentence “Please edit the page your project or [email us]…” would be clearer if revised to “Please edit the page for your project or [email us]…”. This small change improves readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Possible missing preposition found.
Context: ...age](PROJECTS.md). Please edit the page your project or [email us](mailto:contact@sh...(AI_HYDRA_LEO_MISSING_OF)
49-49: Styling: Verb Choice in Issue Reporting
In the 3.0.6 entry, consider replacing “let us know if you see any issues” with “let us know if you encounter any issues” for stronger, more precise wording.🧰 Tools
🪛 LanguageTool
[style] ~49-~49: Consider an alternative verb to strengthen your wording.
Context: ...md) for details, and let us know if you see any issues! [Migration steps from 1.x](...(IF_YOU_HAVE_THIS_PROBLEM)
60-60: Consistency: Naming and Punctuation in CSS Modules Entry
In the entry discussing generator support for building new apps (line 60), consider capitalizing “React on Rails” consistently instead of the snake_case “react_on_rails.” In addition, inserting a comma after “fresh app from React on Rails” can improve readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...modules and hot reloading via the Rails server as is demonstrated in the [shakacode/re...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~60-~60: “React” is a proper noun and needs to be capitalized.
Context: ...._ If you did generate a fresh app from react_on_rails and want to move to CSS Module...(A_GOOGLE)
[style] ~60-~60: Using many exclamation marks might seem excessive (in this case: 20 exclamation marks for a text that’s 8677 characters long)
Context: ...information. Ping us if you want to help! - ShakaCode...(EN_EXCESSIVE_EXCLAMATION)
60-63: Styling: Tone and Exclamation Mark Usage
Across the later entries, please review the overall use of exclamation marks. Excessive exclamation marks can affect the professional tone of the document. A more measured use of punctuation might be preferable.🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...modules and hot reloading via the Rails server as is demonstrated in the [shakacode/re...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~60-~60: “React” is a proper noun and needs to be capitalized.
Context: ...._ If you did generate a fresh app from react_on_rails and want to move to CSS Module...(A_GOOGLE)
[style] ~60-~60: Using many exclamation marks might seem excessive (in this case: 20 exclamation marks for a text that’s 8677 characters long)
Context: ...information. Ping us if you want to help! - ShakaCode...(EN_EXCESSIVE_EXCLAMATION)
docs/guides/rails-webpacker-react-integration-options.md (5)
10-14: Table Formatting: Verify Extra Column
The updated markdown table header now includes an additional column labeled “---” at the end. Please double‐check whether this extra column is intentional or an inadvertent artifact of the formatting fixes.
50-54: Event Listener and Data Parsing Clarity
The code snippet rendering theHellocomponent viaReactDOM.renderis now clearly formatted. As a small recommendation, consider a null-check onnodeto avoid potential runtime errors in production use.
134-143: Conditional Plugin Append for React Refresh
The conditional block appendingReactRefreshWebpackPluginonly whenisWebpackDevServeris true is correctly implemented. As a minor suggestion, consider adding error handling in caseenvironment.pluginsis unexpectedly undefined.
156-159: Babel Configuration Instruction Improvement
When instructing users to updatebabel.config.jsfor thereact-hot-loader/babelplugin, consider adjusting the text to “with the option 'safetyNet': false” to improve grammatical clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~157-~157: You might be missing the article “the” here.
Context: ...pluginreact-hot-loader/babelwith option"safetyNet": false: ``` { "plugi...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
159-159: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
204-216: Webpack Environment Alias for React Hot Loader
The update that merges a new resolution alias—mapping'react-dom'to'@hot-loader/react-dom'—helps mitigate issues related to React Hot Loader. This change is well justified; however, review if a similar adjustment is necessary for production configurations.docs/guides/render-functions-and-railscontext.md (2)
42-42: Nitpick: Revise Wording for ClarityThe note on line 42 would read more naturally with an article for clarity. Consider revising it to, for example, "an alternate API where you have to call React.createElement…"
🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: You might be missing the article “an” here.
Context: ...yAppComponent; ``` --- _This would be alternate API where you have to call React.create...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
126-137: Refined HelloWorld Component ExampleIn the HelloWorld component example, the formatting improvements on lines 132 and 137 enhance the readability of the JSX structure. The clear indentation and use of line breaks reinforce consistency with Prettier standards, making the example easier to follow for users integrating locale information.
docs/guides/how-to-use-different-files-for-client-and-server-rendering.md (1)
95-98: Nitpick: Consider reviewing extra whitespace in the conditional code example.In the code block:
if (window) { // window should be falsy on the server side doSomethingClientOnly(); // or do an import const foobar = require('foobar').default; }An extra blank line appears (at line 98). Verify whether this spacing is intentional for clarity or if a more compact style is preferred for consistency with other code examples.
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (2)
85-86: Nitpick: Refine overlay configuration explanation.The explanation—
We added `overlay.sockPort` option in `ReactRefreshWebpackPlugin` to match the webpack dev-server port specified in `config/shakapacker.yml`. That way we make sockjs works properly and suppress error in browser console `GET http://localhost:[port]/sockjs-node/info?t=[xxxxxxxxxx] 404 (Not Found)`.—could be slightly reworded for grammatical precision. For example:
"We added the
overlay.sockPortoption inReactRefreshWebpackPluginto match the webpack dev-server port specified inconfig/shakapacker.yml. This ensures that sockjs operates correctly and suppresses the404 (Not Found)error in the browser console."This is a stylistic suggestion that would further polish the documentation.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~85-~85: You might be missing the article “the” here.
Context: ... }) ) } ``` We addedoverlay.sockPortoption in `ReactRefres...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~85-~85: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...akapacker.yml`. That way we make sockjs works properly and suppress error in browser ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
96-98: Tone: Consider formalizing the closing remarks.The closing lines (“That’s it :). Now Browser should reflect…”) are friendly but slightly informal. You might consider a slightly more formal tone—for example:
"That concludes the configuration. The browser should now reflect both JavaScript and CSS changes without a full reload."
This would maintain a professional documentation voice.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~98-~98: You might be missing the article “the” here.
Context: ...olean) } } ``` That's it :). Now Browser should reflect .js along with .css chan...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
PROJECTS.md (3)
14-38: Editorial Enhancements in Commercial Products Section
This section’s formatting has been updated for improved readability. Consider the following editorial improvements for consistency and clarity:
- Line 15 (RedFlagDeals): Consider adding "a" before "Canadian shopping site" to read as "a Canadian shopping site."
- Line 22 (KissKissBankBank): Similarly, add "a" before "large French crowdfunding platform" for clarity.
- Line 29 (Deliveroo): Change "multi-lingual" to "multilingual" to align with standard usage.
- General: Review the compound adjective usage (e.g., in the "[first]" entry) to verify if additional hyphenation is needed.
Suggested changes:
- **[RedFlagDeals](https://www.redflagdeals.com/)**, Canadian shopping site. + **[RedFlagDeals](https://www.redflagdeals.com/)**, a Canadian shopping site. - **[KissKissBankBank](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. + **[KissKissBankBank](https://www.kisskissbankbank.com/)**, a large French crowdfunding platform. - **[Deliveroo](https://deliveroo.co.uk/)**: The leading food delivery site in Europe has gone live with React on Rails, with multi-lingual JavaScript support! + **[Deliveroo](https://deliveroo.co.uk/)**: The leading food delivery site in Europe has gone live with React on Rails, with multilingual JavaScript support!🧰 Tools
🪛 LanguageTool
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...eals](https://www.redflagdeals.com/)**, Canadian shopping site. - **[YourMechanic](https...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~22-~22: You might be missing the article “a” here.
Context: ...](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. - **[HVMN...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~29-~29: This word is normally spelled as one.
Context: ...has gone live with React on Rails, with multi-lingual JavaScript support!  : Step-by-step tutorial... + [Hot Module Replacement with react_on_rails](https://medium.com/@hrishio/lesson-5-hot-module-replacement-for-react-in-rails-using-the-react-on-rails-gem-643c5b01f3d7#.ehevxok16): Step-by-step tutorial...
58-61: "Projects Based on React on Rails" List Consistency
The formatting of the list is now consistent. As a minor editorial note, consider hyphenating "open-source" in line 61 to ensure that the compound adjective is correctly presented.Suggested change:
- [github.com/sharetribe/sharetribe](https://github.com/sharetribe/sharetribe): Open source marketplace platform. + [github.com/sharetribe/sharetribe](https://github.com/sharetribe/sharetribe): Open-source marketplace platform.🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ps://github.com/sharetribe/sharetribe): Open source marketplace platform.(EN_COMPOUND_ADJECTIVE_INTERNAL)
CONTRIBUTING.md (3)
21-34: IDE Setup Section – Consider a Minor Punctuation AdjustmentThe IDE setup section is now well organized via a clearly formatted list of directories for exclusion. As a minor nitpick, consider adding a comma after "Otherwise" in line 22 to improve grammatical clarity (i.e. "Otherwise, your IDE might slow to a crawl!").
🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...E/editor to ignore certain directories. Otherwise your IDE might slow to a crawl! - /cov...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
80-83: Workflow Instructions – Consider Wording RefinementsThe workflow steps for pushing node package changes are clearly outlined. As a suggestion, consider rephrasing or shortening the consecutive steps (currently starting with "1. Make changes…" and "2. We need yalc…") to avoid repetitive sentence constructions and improve conciseness.
🧰 Tools
🪛 LanguageTool
[style] ~81-~81: Consider shortening or rephrasing this to strengthen your wording.
Context: ...eact-on-rails ``` The workflow is: 1. Make changes to the node package. 2. We need yalc to pu...(MAKE_CHANGES)
184-186: Suggestion: Vary Sentence Beginnings in the Dummy App SectionIn the "Starting the Dummy App" segment (lines 184–186), several sentences begin similarly (e.g., multiple "If" clauses). Consider rephrasing some of these sentences to vary the structure for improved readability and flow.
🧰 Tools
🪛 LanguageTool
[style] ~185-~185: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...figs, then you need to restart foreman. If you change the JS code for react-on-rai...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
docs/javascript/angular-js-integration-migration.md (1)
6-7: Improve Word Choice for ClarityIn the "Assets Handling" section, consider revising “setup” to “set up” (when used as a verb). Also, replace “no different than” with “no different from” for a more formal tone.
[grammar]🧰 Tools
🪛 LanguageTool
[grammar] ~7-~7: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ave not already done this, then you can setup theReactOnRailsdefault JS code dire...(NOUN_VERB_CONFUSION)
[style] ~7-~7: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style.
Context: ...inclusion this way will be no different than using the Rails asset pipeline. However...(DIFFERENT_THAN)
[uncategorized] ~7-~7: “you” seems less likely than “you’re” (you are).
Context: ...ils asset pipeline. However, so long as you understand how your JavaScript will e...(AI_HYDRA_LEO_CP_YOU_YOUARE)
docs/javascript/react-router.md (1)
36-38: Fix Compound Adjective for ClarityConsider hyphenating “server side bundle” to “server‑side bundle” for grammatical correctness.
[grammar]docs/javascript/react-helmet.md (3)
10-12: Remove Duplicate InstructionThe instruction “Create a render-function for server rendering like this:” appears twice. Consider removing the duplicate line to avoid redundancy.
🧰 Tools
🪛 LanguageTool
[style] ~10-~10: Consider a shorter alternative to avoid wordiness.
Context: ...## Example Here is what you need to do in order to configure your Rails application to wor...(IN_ORDER_TO_PREMIUM)
36-43: Clarify Non-Working Render-Function ExampleThe example using double curly braces (
<App {{railsContext, ...props}} />) may be confusing. Although it’s intended to illustrate an incorrect pattern, consider adding a clarifying comment on why this syntax is invalid in JSX.🧰 Tools
🪛 LanguageTool
[uncategorized] ~36-~36: Possible missing comma found.
Context: .....props} />; ``` Or a render-function. Note you can't return just the JSX (React el...(AI_HYDRA_LEO_MISSING_COMMA)
89-91: Improve Article Usage for ClarityConsider revising the sentence to “… it will return a hash instead of an HTML string” (insert “an” before “HTML string”) for grammatical correctness.
[grammar]docs/misc/doctrine.md (5)
25-30: Consistent Bullet List Formatting for "Convention over Configuration"
The bullet list items have been updated with hyphen prefixes, which improves consistency. One minor suggestion: in the sentence “...you’d have to figure out how to splice it all together”, consider whether using the adverb “altogether” might improve clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: Write this as one word if you mean the noun “workout”.
Context: ...on - React on Rails has taken the hard work out of figuring out the JavaScript tooling ...(WORK_COMPOUNDS)
[grammar] ~27-~27: Using the adverb ‘altogether’ may be more appropriate in this context.
Context: ...u'd have to figure out how to splice it all together. This is where a lot of "JavaScript fat...(ALTOGETHER)
57-60: Hyphenation for Compound Adjectives
In line 59, the phrase “client side development” appears; for clarity and consistency, consider changing it to “client‑side development”.- client side development + client-side development🧰 Tools
🪛 LanguageTool
[uncategorized] ~59-~59: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... from the perspective that it rocks for client side development with Rails, even though it'...(EN_COMPOUND_ADJECTIVE_INTERNAL)
61-64: Compound Adjective Consistency in "Exalt Beautiful Code"
In line 63, “Client side code” should be hyphenated as “client‑side code” for consistency with compound adjective usage.- Client side code + client-side code🧰 Tools
🪛 LanguageTool
[uncategorized] ~63-~63: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... ES6 is beautiful. React is beautiful. Client side code written with React plus Redux, ful...(EN_COMPOUND_ADJECTIVE_INTERNAL)
65-72: Clarity and Consistency in "Value Integrated Systems"
- The phrase “…document/database based with lots of business rules…” in line 67 might be improved by replacing “lots of” with a more formal term such as “numerous” or “a significant number of”.
- In the same sentence, consider hyphenating “pure client side app” to “pure client‑side app”.
- In line 71, the bullet mentions “React driven pages”; it would be clearer as “React‑driven pages”.
- pure client side app + pure client-side app- React driven pages + React‑driven pages🧰 Tools
🪛 LanguageTool
[style] ~67-~67: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...for Rails (document/database based with lots of business rules), the tight integration ...(A_LOT_OF)
[uncategorized] ~67-~67: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on Rails is better than building a pure client side app and separate microservices. Here's ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~71-~71: The adjective “React-driven” is spelled with a hyphen.
Context: ...ws mixing and matching Rails pages with React driven pages, even on the same page. Not every...(DRIVEN_HYPHEN)
73-80: Bullet List Consistency in "Progress over Stability"
The list in this section is neatly formatted. As a consistency note, if any bullet points refer to compound terms like “client side tooling”, consider using the hyphenated form “client‑side tooling”.- New client side tooling, libraries, and techniques. + New client-side tooling, libraries, and techniques.🧰 Tools
🪛 LanguageTool
[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p with: - Community suggestions. - New client side tooling, libraries, and techniques. - U...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/contributor-info/generator-testing.md (2)
3-3: Nitpick: Redundant Descriptor
The phrase “various different options” is redundant. Consider simplifying it to “various options” or “different options” for clarity.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: This phrase is redundant. Consider writing “various” or “different”.
Context: ...act_on_rails/install_generator.rb) with various different options. We can then run tests with the...(VARIOUS_DIFFERENT)
9-9: Punctuation Suggestion for Clarity
Consider inserting a comma before “or” in “... add that dependency to the main Gemfile or it will not work in CI” to clearly separate the independent clauses.🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... add that dependency to the main Gemfile or it will not work in CI. ## Configuring...(COMMA_COMPOUND_SENTENCE)
docs/contributor-info/pull-requests.md (1)
12-12: Minor Language Improvement
In the first bullet point, consider adding an article for clarity (e.g., “Provide a changelog entry in the…”) to improve the flow.🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Possible missing article found.
Context: ...d entry? For non-doc fixes: - Provide changelog entry in the [unreleased section of the...(AI_HYDRA_LEO_MISSING_A)
docs/guides/tutorial.md (3)
22-23: Avoid bare URLs in list items.
Consider wrapping these URLs in angle brackets or providing descriptive link text to better comply with Markdown linting guidelines (MD034).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
22-22: Bare URL used
null(MD034, no-bare-urls)
23-23: Bare URL used
null(MD034, no-bare-urls)
74-76: Improve note grammatical clarity.
Consider revising the note to “Note: You can use the--database=postgresqloption to use PostgreSQL for the database” for improved grammatical accuracy and clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~75-~75: You might be missing the article “the” here.
Context: ...t-react-on-rails ``` Note: You can use--database=postgresqloption to use Pos...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
367-368: Grammar: Consider adding a comma for clarity.
Adding a comma after “different IP or PORT” (e.g., “...with different IP or PORT, you should also edit Procfile.dev”) would improve the sentence’s readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~368-~368: A comma might be missing here.
Context: ...ample, to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/release-notes/15.0.0.md (3)
6-9: Enhance Clarity in the React Server Components Section.
The added lines introduce the React Server Components support and its benefits clearly. Please verify that the list styling (e.g. bullet markers and indentation) is consistent with the project’s documentation guidelines.
15-17: Clarify the “Improved Component Hydration” Section.
The modifications emphasize that components and stores now hydrate immediately. For extra clarity, consider rephrasing to, for example, "Components and stores now hydrate immediately rather than waiting for the full page load."
27-34: Refine Breaking Changes Details and Grammar.
The updated details regarding the default values ofdefer_generated_component_packsandforce_loadare informative. However, note the following adjustments:
- On line 31, change "The
force_loadconfiguration make" to "Theforce_loadconfiguration makes" for correct subject–verb agreement.- Review compound adjectives and punctuation as indicated by static analysis (for example, consider a hyphen in terms like "full-page load" if appropriate).
- In the later sentences, ensure consistency in phrasing when discussing configuration overrides.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...l hydrate early without waiting for the full page load. This improves performance by elim...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ded. - Theforce_loadconfiguration makereact-on-railshydrate components imm...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...hes the client, without waiting for the full page load. - If you want to keep the previ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...zers/react_on_rails.rbfile. - If we want to keep the original behavior offorce_lo...(REP_WANT_TO_VB)
[uncategorized] ~34-~34: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ce_loadconfiguration. - Redux store supportforce_loadoption now and it usesco...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~34-~34: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ux store supportforce_loadoption now and it usesconfig.force_loadvalue as th...(COMMA_COMPOUND_SENTENCE)
docs/javascript/webpack.md (1)
3-6: Grammatical Clarity in Introductory Text
The text on lines 3–6 would read more naturally with an article added. Consider changing “example app” to “an example app” to improve grammatical correctness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: You might be missing the article “an” here.
Context: ... "Code Splitting", etc You can try out example app, [shakacode/react-webpack-rails-tut...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/guides/webpack-configuration.md (2)
27-27: Improvement on Punctuation
In the sentence on line 27, consider adding a comma before “and” to separate the independent clauses (“...get started, and you don't need to understand...”).🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s very little code needed to get started and you don't need to understand really any...(COMMA_COMPOUND_SENTENCE)
41-42: Markdown Formatting Suggestion
The list items on lines 41–42 use bare URLs. For consistency with markdownlint recommendations, consider wrapping these URLs in angle brackets or converting them to explicit markdown links.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
41-41: Bare URL used
null(MD034, no-bare-urls)
42-42: Bare URL used
null(MD034, no-bare-urls)
docs/getting-started.md (3)
144-144: Punctuation and Compound Adjective
In the sentence on line 144, consider hyphenating “server side” to “server-side” when used as a compound adjective (e.g. “server-side entry file”) for improved clarity and consistency.🧰 Tools
🪛 LanguageTool
[uncategorized] ~144-~144: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...(EN_COMPOUND_ADJECTIVE_INTERNAL)
183-188: Review Object Literal Syntax
In the provided example forreact_component_hash, the object literal uses a semicolon after listing property names. Verify that this syntax is intentional; typically, commas are used to separate properties.
199-199: Locale Conversion Syntax
The line on 199 mentions converting Rails*.ymlfiles into*.jsonor_.js_. Please verify if the “.js” part is correctly formatted or if it should instead be a code-formatted extension (e.g..js).docs/guides/client-vs-server-rendering.md (1)
25-25: Punctuation and Adjective Consistency
On line 25, consider hyphenating “server side” to “server-side” to form a compound adjective (“server-side entry file”), which enhances clarity and conforms to standard style conventions.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...(EN_COMPOUND_ADJECTIVE_INTERNAL)
spec/dummy/README.md (1)
3-4: Clarify dependency instructions and naming consistency.
The lines removed or altered here adjust the guidance regarding linking the client’s node_modules. Consider hyphenating “top level” to “top-level” for clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e spec/dummy/client/node_modules to the top level - Be sure to install yarn dependencies ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/home.md (1)
17-22: Refine phrasing in the Example Apps section.
In the second list item, consider changing “a new way to setup the creation…” to “a new way to set up the creation…” to use the proper verb form.🧰 Tools
🪛 LanguageTool
[grammar] ~22-~22: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `s...(NOUN_VERB_CONFUSION)
README.md (1)
93-100: Updated Support section with clear calls-to-action.
The revised bullet list provides multiple ways to engage with the community. To further align with markdownlint guidelines, consider standardizing the unordered list marker (e.g. using dashes instead of asterisks).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
97-97: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
98-98: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
99-99: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
100-100: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
docs/outdated/rails-assets.md (3)
3-3: Formatting: Emphasized Update NoticeThe italicized text on this line clearly signals that the document needs updating for the use of Shakapacker or rails/webpacker with React on Rails. If this note is meant to catch the reader’s attention (and not serve as a section heading), the current emphasis is appropriate. However, you might consider using a callout or a blockquote format if you want the update notice to stand out even more.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
8-9: Grammar Suggestion: Insert Comma for ClarityLanguageTool hints that adding a comma after "By default" can improve readability. For example, updating the line to:
> By default, the filename of the resulting file is the MD5 hash of the file's contents with
may read more naturally.🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: Did you mean: “By default,”?
Context: ...e other term for this is a "digest". > By default the filename of the resulting file is t...(BY_DEFAULT_COMMA)
37-39: Styling Note: Clarifying the Symlink Solution UpdateThe italicized note about the removal of the symlink solution in v14 clearly communicates that this approach is no longer supported and directs users to create a GitHub issue if further help is needed. For improved visual distinction, consider using a blockquote or another callout style. The current format works, but a slight style adjustment might increase visibility.
KUDOS.md (3)
48-49: Content & Style Suggestion for "### February 24, 2017" Section
The change at line 48 (affecting the subsequent quote on line 49) improves formatting; however, the static analysis hints suggest considering a more formal alternative to “awesome” and ensuring proper capitalization where necessary. This is a nitpick regarding tone rather than a functional error.🧰 Tools
🪛 LanguageTool
[style] ~49-~49: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ators are great and the community is so awesome and welcoming. In fact, I love it so mu...(AWESOME)
[grammar] ~49-~49: “React” is a proper noun and needs to be capitalized.
Context: ...Rails](https://goo.gl/uzu36X) using the react_on_rails gem!" ![The Complete React on ...(A_GOOGLE)
101-102: Formatting & Style Suggestion for "### March 30, 2016" Section
The update starting at line 101 refines the header separation for this section. Note that the quoted text on line 102 contains an exclamation mark; if the intention is to reduce excessive punctuation (as per the static analysis hint), consider if this can be toned down for consistency with the document’s overall style.🧰 Tools
🪛 LanguageTool
[style] ~102-~102: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1997 characters long)
Context: ...ls gems to manage front end dependencies! React on Rails provides webpack integra...(EN_EXCESSIVE_EXCLAMATION)
105-106: Formatting Update: Review Bare URL in "### March 25, 2016" Section
The change on line 105 refines the header or preceding formatting. Additionally, be aware that the bare URL on the following line (line 106) has been flagged by markdownlint (MD034). Consider wrapping the URL in<...>or converting it into a proper markdown link if deemed necessary.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
106-106: Bare URL used
null(MD034, no-bare-urls)
docs/rails/turbolinks.md (12)
4-7: Update and Clarify Reference Links.
The header and the subsequent reference lines now provide clear pointers to prior PRs and denote Turbo support. Consider rephrasing “as Turbolinks gets obsolete” to “as Turbolinks becomes obsolete” for improved clarity.
16-16: Address the TODO Reminder.
The placeholder “TODO: Walk through code changes in PR 1620.” is still present. Please update this section with the final details or remove it if it is no longer needed.
20-24: Clarify the Outdated Docs Notice.
The italicized note indicates that the docs below might be outdated. For clarity, consider rephrasing to something like:
"The documentation below may be outdated. We recommend updating to the latest Turbo or removing information related to old Turbolinks."
27-29: Refine Sentence Structure in “Why Turbolinks?” Section.
The sentence starting on line 27 is split across lines and may impact readability. A suggested rephrasing is:
"Switching between Rails HTML controller requests means that only the HTML is loaded—JavaScript and stylesheets are not reloaded—even if they’re cached, which can improve performance."🧰 Tools
🪛 LanguageTool
[uncategorized] ~29-~29: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...reload JavaScript and stylesheets. This definitely can make an app perform better, even if the...(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
33-34: Enhance Clarity of Requirements.
For the first requirement, consider rephrasing for clarity:
"Either avoid using react-router or be prepared to handle potential conflicts between react-router and Turbolinks."
37-40: Fix List Numbering in "Why Not Turbolinks".
Both list items are numbered “1.” This could lead to formatting issues in the rendered markdown. Correct the numbering (e.g., 1 and 2) so that the list is clear.
43-44: Improve Grammar and Clarity in the “More Information” Section.
The text discussing CSRF tokens and request headers has several grammatical issues:
- Consider breaking the long sentence into shorter, clearer sentences.
- For example, revise “I didn't look details however, may be it is app code related, not library code.” to “I didn’t examine the details; however, it may be related to application code rather than the library.”
- In the next bullet, rephrase to:
"Turbolinks5 sends requests without theAccept: */*header, usingAccept: text/htmlinstead. This causes Rails to behave differently in MIME parsing. For more details, refer to Mime Type Resolution in Rails."
[uncategorized]🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...he head element by JavaScript (not only body) on page changes with the correct csrf ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...ag, but if the JS code parsed this from head when several windows were opened, then ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~44-~44: Consider inserting a comma before ‘however’.
Context: ...ecs were not all passing. I didn't look details however, may be it is app code related, not libr...(HOWEVER_MISSING_COMMA)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ... is app code related, not library code. Anyway it may need additional check because th...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~44-~44: You might be missing the article “a” here.
Context: ... need additional check because there is CSRF helper in ReactOnRails and it need to w...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Tur...(COMMA_COMPOUND_SENTENCE)
[grammar] ~44-~44: The pronoun ‘it’ requires a third-person verb or a past tense.
Context: ...e is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Turbolinks5...(HE_NEED)
45-45: Clarify Webpack Bundles Recommendation.
The note on avoiding name conflicts between JS objects or Redux store paths is useful. Consider providing additional context or examples if feasible.🧰 Tools
🪛 LanguageTool
[uncategorized] ~45-~45: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...to work with Turbolinks5. - Turbolinks5 send requests without theAccept: */*in t...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
48-56: Improve the Install Checklist Formatting.
The checklist is clear, but the list numbering appears inconsistent (e.g., two items labeled as “1.”). Standardizing the numbering will enhance readability. Also, double-check that the embedded ERB snippet renders correctly in context.
88-92: Deferred Script Loading Workaround Explanation.
The workaround recommending the use ofdeferoverasyncis a useful addition. For improved clarity, consider rephrasing the explanatory text to:
"If you usedocument.addEventListener("turbolinks:load", ...), you might notice that Turbolinks 5 does not fire this event on the initial page load. As a workaround, usedeferfor script loading."
94-102: Clarify Asynchronous Loading Guidance.
The section explaining potential registration issues with Components and the use ofReactOnRails.reactOnRailsPageLoaded()is helpful. Please remove the unnecessary comma in “you may experience, that” to read as “you may experience that.”🧰 Tools
🪛 LanguageTool
[typographical] ~96-~96: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’.
Context: ...cripts asynchronously you may experience, that your Components are not registered corr...(COMMA_THAT_NOUN)
150-153: Enhance Image Accessibility.
The image is referenced with a filename that does not provide descriptive alt text. Consider adding a descriptive alt attribute to improve accessibility for users relying on screen readers.🧰 Tools
🪛 LanguageTool
[uncategorized] ~150-~150: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...y gem version of jQuery and jQuery ujs. Therefore we recommend using the node packages in...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
docs/guides/upgrading-react-on-rails.md (7)
38-41: i18n Configuration UpdateThe previous instruction for setting
config.i18n_output_formathas been removed. Ensure that users understand that the default JSON format is now used and that any necessary code updates are documented elsewhere.🧰 Tools
🪛 LanguageTool
[uncategorized] ~41-~41: Possible missing comma found.
Context: ... can later update to the default JSON format as you will need to update your usage o...(AI_HYDRA_LEO_MISSING_COMMA)
56-59: Function Description ClarityThe text describing functions that return a React Element could be rephrased for clarity and grammatical correctness. For example, consider revising as follows:
-1. **Function that takes only zero or one params and you return a React Element**, often JSX. +1. **Function that takes zero or one parameter and returns a React Element**, often JSX.🧰 Tools
🪛 LanguageTool
[uncategorized] ~56-~56: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ction that takes only zero or one params and you return a React Element**, often JSX...(COMMA_COMPOUND_SENTENCE)
62-63: Object-Returning Function WordingSimilarly, the description for functions returning an Object would benefit from a slight rewording and punctuation tweak. For example:
-2. **Function that takes only zero or one params and you return an Object (_not a React Element_)**. +2. **Function that takes zero or one parameter, and returns an Object (not a React Element)**.This improves readability and consistency.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ction that takes only zero or one params and you return an Object (_not a React Elem...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ion will be treated as a render function and it can return an Object rather than a R...(COMMA_COMPOUND_SENTENCE)
71-73: Arrow Function Object Literal ExampleThe code example here could be misleading because the arrow function uses braces without a return statement. To clarify the intended behavior, consider using parentheses to implicitly return an object literal:
-export default (props, _railsContext) => { - renderedHTML: getRenderedHTML; -}; +export default (props, _railsContext) => ({ renderedHTML: getRenderedHTML });This makes the snippet both syntactically correct and easier for users to copy.
79-82: Consistent Object Literal ReturnThe subsequent code snippet (lines 79–82) repeats the same pattern. The same suggestion applies here:
-export default (props, _railsContext) => { - renderedHTML: getRenderedHTML; -}; +export default (props, _railsContext) => ({ renderedHTML: getRenderedHTML });This ensures consistency in the documentation examples.
85-89: JSX Syntax in Function Component ExampleIn the function component example, the JSX is written as
<Component {{...props, railsContext}} />which appears to include extra curly braces. Please verify and consider revising to something like:-export default (props, railsContext) => () => <Component {{...props, railsContext}} />; +export default (props, railsContext) => () => <Component {...props, railsContext} />;This correction will prevent confusion when developers copy the snippet.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~85-~85: Possible missing comma found.
Context: ...ion or class component**. _Migration is needed as the older syntax returned a React El...(AI_HYDRA_LEO_MISSING_COMMA)
242-243: Formatting of Node Modules Location DescriptionThe description for
config.node_modules_locationappears to have some formatting issues with inline code and punctuation. Consider rephrasing it as follows for clarity:-Added `config.node_modules_location` which defaults to `""` if Webpacker is installed. You may want to set this to 'client'`to`config/initializers/react_on_rails.rb`to keep your node_modules inside of`/client` +Added `config.node_modules_location` (which defaults to an empty string if Webpacker is installed). You may want to set this to "client" in your `config/initializers/react_on_rails.rb` to keep your node_modules inside `/client`.🧰 Tools
🪛 LanguageTool
[style] ~242-~242: This phrase is redundant. Consider using “inside”.
Context: ...toconfig/initializers/react_on_rails.rbto keep your node_modules inside of/client2. Renamed - config.npm_b...(OUTSIDE_OF)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (86)
.github/ISSUE_TEMPLATE/bug_report.md(0 hunks).github/ISSUE_TEMPLATE/feature_request.md(0 hunks).github/PULL_REQUEST_TEMPLATE.md(1 hunks).prettierrc(1 hunks)CHANGELOG.md(19 hunks)CONTRIBUTING.md(11 hunks)KUDOS.md(1 hunks)NEWS.md(1 hunks)PROJECTS.md(1 hunks)README.md(4 hunks)SUMMARY.md(1 hunks)docs/additional-details/generator-details.md(1 hunks)docs/additional-details/manual-installation-overview.md(1 hunks)docs/additional-details/migrating-from-react-rails.md(1 hunks)docs/additional-details/recommended-project-structure.md(2 hunks)docs/additional-details/tips-for-usage-with-sp6.md(1 hunks)docs/additional-details/updating-dependencies.md(2 hunks)docs/api/javascript-api.md(2 hunks)docs/api/redux-store-api.md(4 hunks)docs/api/view-helpers-api.md(8 hunks)docs/contributor-info/generator-testing.md(1 hunks)docs/contributor-info/linters.md(2 hunks)docs/contributor-info/pull-requests.md(2 hunks)docs/contributor-info/releasing.md(1 hunks)docs/deployment/elastic-beanstalk.md(1 hunks)docs/deployment/heroku-deployment.md(1 hunks)docs/getting-started.md(7 hunks)docs/guides/client-vs-server-rendering.md(2 hunks)docs/guides/configuration.md(4 hunks)docs/guides/file-system-based-automated-bundle-generation.md(5 hunks)docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md(2 hunks)docs/guides/how-react-on-rails-works.md(2 hunks)docs/guides/how-to-use-different-files-for-client-and-server-rendering.md(3 hunks)docs/guides/i18n.md(1 hunks)docs/guides/installation-into-an-existing-rails-app.md(2 hunks)docs/guides/minitest-configuration.md(1 hunks)docs/guides/rails-webpacker-react-integration-options.md(7 hunks)docs/guides/react-on-rails-overview.md(1 hunks)docs/guides/react-server-rendering.md(2 hunks)docs/guides/render-functions-and-railscontext.md(6 hunks)docs/guides/rspec-configuration.md(4 hunks)docs/guides/streaming-server-rendering.md(4 hunks)docs/guides/tutorial.md(12 hunks)docs/guides/upgrading-react-on-rails.md(13 hunks)docs/guides/webpack-configuration.md(2 hunks)docs/home.md(2 hunks)docs/javascript/angular-js-integration-migration.md(2 hunks)docs/javascript/capistrano-deployment.md(1 hunks)docs/javascript/code-splitting.md(5 hunks)docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md(1 hunks)docs/javascript/credits.md(0 hunks)docs/javascript/foreman-issues.md(1 hunks)docs/javascript/images.md(0 hunks)docs/javascript/node-dependencies-and-npm.md(1 hunks)docs/javascript/react-and-redux.md(1 hunks)docs/javascript/react-helmet.md(6 hunks)docs/javascript/react-router.md(3 hunks)docs/javascript/server-rendering-tips.md(2 hunks)docs/javascript/troubleshooting-when-using-shakapacker.md(1 hunks)docs/javascript/troubleshooting-when-using-webpacker.md(1 hunks)docs/javascript/webpack-v1-notes.md(1 hunks)docs/javascript/webpack.md(2 hunks)docs/misc/articles.md(1 hunks)docs/misc/doctrine.md(2 hunks)docs/misc/style.md(1 hunks)docs/misc/tips.md(1 hunks)docs/outdated/deferred-rendering.md(2 hunks)docs/outdated/rails-assets-relative-paths.md(9 hunks)docs/outdated/rails-assets.md(2 hunks)docs/outdated/rails3.md(1 hunks)docs/rails/rails-engine-integration.md(2 hunks)docs/rails/rails_view_rendering_from_inline_javascript.md(2 hunks)docs/rails/turbolinks.md(3 hunks)docs/release-notes/15.0.0.md(3 hunks)docs/testimonials/resortpass.md(1 hunks)docs/testimonials/testimonials.md(1 hunks)knip.ts(1 hunks)lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.module.css(1 hunks)package-scripts.yml(2 hunks)package.json(1 hunks)spec/dummy/README.md(2 hunks)spec/dummy/app/assets/stylesheets/application_non_webpack.scss(1 hunks)spec/dummy/client/README.md(3 hunks)spec/dummy/client/app/components/CssModulesImagesFontsExample.module.scss(2 hunks)spec/dummy/client/app/components/ImageExample/ImageExample.module.scss(1 hunks)spec/dummy/client/app/startup/RouterApp.server.jsx(1 hunks)
💤 Files with no reviewable changes (4)
- docs/javascript/images.md
- docs/javascript/credits.md
- .github/ISSUE_TEMPLATE/bug_report.md
- .github/ISSUE_TEMPLATE/feature_request.md
✅ Files skipped from review due to trivial changes (1)
- docs/misc/articles.md
🚧 Files skipped from review as they are similar to previous changes (33)
- spec/dummy/app/assets/stylesheets/application_non_webpack.scss
- docs/additional-details/updating-dependencies.md
- docs/testimonials/testimonials.md
- docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md
- docs/outdated/deferred-rendering.md
- lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.module.css
- docs/javascript/foreman-issues.md
- docs/guides/minitest-configuration.md
- spec/dummy/client/app/startup/RouterApp.server.jsx
- docs/guides/rspec-configuration.md
- .github/PULL_REQUEST_TEMPLATE.md
- docs/deployment/heroku-deployment.md
- knip.ts
- docs/javascript/node-dependencies-and-npm.md
- spec/dummy/client/app/components/ImageExample/ImageExample.module.scss
- docs/guides/configuration.md
- docs/guides/react-server-rendering.md
- docs/javascript/troubleshooting-when-using-shakapacker.md
- docs/additional-details/migrating-from-react-rails.md
- docs/additional-details/tips-for-usage-with-sp6.md
- docs/guides/streaming-server-rendering.md
- SUMMARY.md
- docs/javascript/code-splitting.md
- docs/guides/react-on-rails-overview.md
- spec/dummy/client/app/components/CssModulesImagesFontsExample.module.scss
- docs/guides/installation-into-an-existing-rails-app.md
- .prettierrc
- docs/contributor-info/releasing.md
- docs/rails/rails_view_rendering_from_inline_javascript.md
- package.json
- docs/api/redux-store-api.md
- package-scripts.yml
- docs/api/javascript-api.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CHANGELOG.md
9-9: Bare URL used
null
(MD034, no-bare-urls)
245-245: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
427-427: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
428-428: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
452-452: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
617-617: Bare URL used
null
(MD034, no-bare-urls)
621-621: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
745-745: Spaces inside link text
null
(MD039, no-space-in-links)
750-750: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
753-753: Spaces inside link text
null
(MD039, no-space-in-links)
761-761: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
767-767: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
780-780: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
796-796: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
798-798: Bare URL used
null
(MD034, no-bare-urls)
803-803: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
809-809: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
834-834: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
838-838: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
844-844: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
854-854: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
860-860: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
866-866: Spaces inside link text
null
(MD039, no-space-in-links)
870-870: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
876-876: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
887-887: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
893-893: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
899-899: Bare URL used
null
(MD034, no-bare-urls)
908-908: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
914-914: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
926-926: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
936-936: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
961-961: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
967-967: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
975-975: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
985-985: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
995-995: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
1009-1009: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
1015-1015: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1021-1021: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1028-1028: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1036-1036: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1042-1042: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1060-1060: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1066-1066: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1072-1072: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1074-1074: Spaces inside link text
null
(MD039, no-space-in-links)
1078-1078: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1087-1087: Spaces inside link text
null
(MD039, no-space-in-links)
1093-1093: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1099-1099: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1105-1105: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1111-1111: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1117-1117: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1123-1123: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1183-1183: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1197-1197: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1207-1207: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1239-1239: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1245-1245: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1251-1251: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1257-1257: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1290-1290: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1296-1296: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1302-1302: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1309-1309: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1317-1317: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1323-1323: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1329-1329: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1373-1373: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1381-1381: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1387-1387: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1399-1399: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1433-1433: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
1452-1452: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
1461-1461: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
1467-1467: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
1473-1473: Bare URL used
null
(MD034, no-bare-urls)
1476-1476: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1494-1494: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1504-1504: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1524-1524: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
CONTRIBUTING.md
7-7: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
KUDOS.md
70-70: Bare URL used
null
(MD034, no-bare-urls)
106-106: Bare URL used
null
(MD034, no-bare-urls)
README.md
97-97: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
98-98: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
99-99: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
100-100: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
101-101: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
102-102: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
docs/contributor-info/linters.md
12-12: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
18-18: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
24-24: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/contributor-info/pull-requests.md
22-22: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
docs/guides/file-system-based-automated-bundle-generation.md
163-163: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/guides/how-react-on-rails-works.md
5-5: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
5-5: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
docs/guides/tutorial.md
7-7: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
22-22: Bare URL used
null
(MD034, no-bare-urls)
23-23: Bare URL used
null
(MD034, no-bare-urls)
25-25: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
docs/guides/upgrading-react-on-rails.md
64-64: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
143-143: Bare URL used
null
(MD034, no-bare-urls)
182-182: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
299-299: Bare URL used
null
(MD034, no-bare-urls)
303-303: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/guides/webpack-configuration.md
41-41: Bare URL used
null
(MD034, no-bare-urls)
42-42: Bare URL used
null
(MD034, no-bare-urls)
docs/javascript/react-and-redux.md
5-5: Bare URL used
null
(MD034, no-bare-urls)
docs/javascript/troubleshooting-when-using-webpacker.md
10-10: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/outdated/rails-assets-relative-paths.md
1-1: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
docs/outdated/rails-assets.md
3-3: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
spec/dummy/client/README.md
9-9: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
21-21: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
21-21: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
25-25: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
25-25: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~22-~22: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...E/editor to ignore certain directories. Otherwise your IDE might slow to a crawl! - /cov...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~81-~81: Consider shortening or rephrasing this to strengthen your wording.
Context: ...eact-on-rails ``` The workflow is: 1. Make changes to the node package. 2. We need yalc to pu...
(MAKE_CHANGES)
[style] ~185-~185: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...figs, then you need to restart foreman. If you change the JS code for react-on-rai...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~205-~205: A comma might be missing here.
Context: .... ### Install Generator In your Rails app add this gem with a path to your fork. ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~237-~237: The word ‘lint’ is a noun or an adjective. A verb or adverb is missing or misspelled here, or maybe a comma is missing.
Context: ...changes via the lint container. You can lint locally by running `npm run lint && npm...
(PRP_MD_NN)
[grammar] ~242-~242: The word ‘install’ is not a noun.
Context: ...he initial build is slow, but after the install, startup is very quick. ### Linting Co...
(A_INSTALL)
[style] ~242-~242: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...slow, but after the install, startup is very quick. ### Linting Commands Run rake lint...
(EN_WEAK_ADJECTIVE)
KUDOS.md
[style] ~49-~49: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ators are great and the community is so awesome and welcoming. In fact, I love it so mu...
(AWESOME)
[grammar] ~49-~49: “React” is a proper noun and needs to be capitalized.
Context: ...Rails](https://goo.gl/uzu36X) using the react_on_rails gem!" ![The Complete React on ...
(A_GOOGLE)
[style] ~102-~102: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1997 characters long)
Context: ...ls gems to manage front end dependencies! React on Rails provides webpack integra...
(EN_EXCESSIVE_EXCLAMATION)
NEWS.md
[grammar] ~10-~10: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `r...
(NOUN_VERB_CONFUSION)
[uncategorized] ~12-~12: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v12**. 1. React Hooks Support for top level components 2. Typescript bindings...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ...rformance improvements! Please upgrade! Only "breaking" change is that you have to u...
(AI_EN_LECTOR_MISSING_DETERMINER)
[inconsistency] ~29-~29: Did you mean to refer to the current year? November 10, 2025 is not a Thursday, but a Monday.
Context: ...) - 2016-11-03: Spoke at [LA Ruby, 7pm, Thursday, November 10 in Venice, CA: "React on Rails: Why, Wh...
(EN_DATE_WEEKDAY_CURRENTYEAR)
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...with a critical fix if you are fragment caching the server generated React. - 2016-05-2...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~48-~48: Possible missing preposition found.
Context: ...age](PROJECTS.md). Please edit the page your project or [email us](mailto:contact@sh...
(AI_HYDRA_LEO_MISSING_OF)
[style] ~49-~49: Consider an alternative verb to strengthen your wording.
Context: ...md) for details, and let us know if you see any issues! [Migration steps from 1.x](...
(IF_YOU_HAVE_THIS_PROBLEM)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...modules and hot reloading via the Rails server as is demonstrated in the [shakacode/re...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~60-~60: “React” is a proper noun and needs to be capitalized.
Context: ...._ If you did generate a fresh app from react_on_rails and want to move to CSS Module...
(A_GOOGLE)
[style] ~60-~60: Using many exclamation marks might seem excessive (in this case: 20 exclamation marks for a text that’s 8677 characters long)
Context: ...information. Ping us if you want to help! - ShakaCode...
(EN_EXCESSIVE_EXCLAMATION)
PROJECTS.md
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...eals](https://www.redflagdeals.com/)**, Canadian shopping site. - **[YourMechanic](https...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~22-~22: You might be missing the article “a” here.
Context: ...](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. - **[HVMN...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~29-~29: This word is normally spelled as one.
Context: ...has gone live with React on Rails, with multi-lingual JavaScript support! ![2016-05-03_19-1...
(EN_COMPOUNDS_MULTI_LINGUAL)
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...lational Marketing for Real Estate. ## Open Source Projects Live - [github.com/empirical-...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ps://github.com/sharetribe/sharetribe): Open source marketplace platform.
(EN_COMPOUND_ADJECTIVE_INTERNAL)
README.md
[style] ~87-~87: Style-wise, it’s not ideal to insert an adverb (‘conditionally’) in the middle of an infinitive construction (‘to render’). Try moving the adverb to avoid split infinitives.
Context: ...lient-and-server-rendering/1352) - [How to conditionally render server side based on the device type](https://forum...
(SPLIT_INFINITIVE)
docs/additional-details/generator-details.md
[style] ~44-~44: This phrase is redundant. Consider using “inside”.
Context: ... functionality, is given its own folder inside of app/javascript/app/bundles. Note, the...
(OUTSIDE_OF)
[style] ~45-~45: This phrase is redundant. Consider using “Inside”.
Context: ...ncourages for modularity of domains. Inside of the generated "HelloWorld" domain you w...
(OUTSIDE_OF)
[uncategorized] ~46-~46: Possible missing comma found.
Context: .... Inside of the generated "HelloWorld" domain you will find the following folders: -...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...find the following folders: - startup: This contains the entry point files for...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ... with separate endpoints. - containers: "smart components" (components that hav...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...child "dumb components"). - components: includes "dumb components", or componen...
(UNLIKELY_OPENING_PUNCTUATION)
docs/additional-details/manual-installation-overview.md
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...eet_pack_tagandjavascript_pack_tag` helpers which is used to load the bundled asset...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...and javascript_pack_tag helpers which is used to load the bundled assets to your...
(AI_HYDRA_LEO_CPT_IS_ARE)
docs/additional-details/recommended-project-structure.md
[style] ~50-~50: Consider an alternative adjective to strengthen your wording.
Context: ...s asset pipeline. It depends! Here's a good discussion of this option: [Why does Ra...
(GOOD_CONSTRUCTIVE)
[grammar] ~60-~60: Did you mean “There are no changes”?
Context: ... the Simple Rails Way 1. Much simpler! There's no changes really from your current processes. ##...
(THERE_S_MANY)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ctory structure 1. /client/app/assets: Assets for CSS for client app. 1. `/cli...
(UNLIKELY_OPENING_PUNCTUATION)
docs/api/view-helpers-api.md
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... you want to see the server side or the client side rails_context. Typically, for computing...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/contributor-info/generator-testing.md
[style] ~3-~3: This phrase is redundant. Consider writing “various” or “different”.
Context: ...act_on_rails/install_generator.rb) with various different options. We can then run tests with the...
(VARIOUS_DIFFERENT)
[uncategorized] ~9-~9: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... add that dependency to the main Gemfile or it will not work in CI. ## Configuring...
(COMMA_COMPOUND_SENTENCE)
docs/contributor-info/linters.md
[style] ~16-~16: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...` 3. eslint:: Be sure to be in the right directory where you have JS files. ```...
(REP_RIGHT)
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ... Useful Reference Links - Configuring ESLint - [ESLint quick start](http://untilfalse.com/esli...
(ENGLISH_WORD_REPEAT_RULE)
docs/contributor-info/pull-requests.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...# Checklist before Committing 1. rake: runs all linters and specs (you need Do...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Possible missing article found.
Context: ...d entry? For non-doc fixes: - Provide changelog entry in the [unreleased section of the...
(AI_HYDRA_LEO_MISSING_A)
docs/deployment/elastic-beanstalk.md
[grammar] ~47-~47: “React” is a proper noun and needs to be capitalized.
Context: ...ic beanstalk successfully. However, the react app javascript files are under `public/...
(A_GOOGLE)
docs/getting-started.md
[uncategorized] ~144-~144: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/client-vs-server-rendering.md
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/file-system-based-automated-bundle-generation.md
[typographical] ~180-~180: After the expression ‘for example’ a comma is usually used.
Context: ...ry` nor directly add their bundles. For example you can have a Rails view using three c...
(COMMA_FOR_EXAMPLE)
[style] ~207-~207: Consider a shorter alternative to avoid wordiness.
Context: ...ge both in server and client rendering. In order to have separate definitions for client an...
(IN_ORDER_TO_PREMIUM)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...efresh). For use with webpack, see **Client Side rendering and HMR using react-refresh-w...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~17-~17: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...cker-dev-server` during development. # Server Side Rendering with the Default shakacode/sh...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~19-~19: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ... server-side rendering, then you have a couple options. The recommended technique is to have a...
(PLENTY_OF_NOUNS)
[uncategorized] ~43-~43: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...' of undefined" (if inline is true)` # Client Side rendering with HMR using react-refresh-...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...n ## Basic installation To enable HMR functionality you have to use `./bin/shakapacker-dev-...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~85-~85: You might be missing the article “the” here.
Context: ... }) ) } ``` We added overlay.sockPort option in `ReactRefres...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~85-~85: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...akapacker.yml`. That way we make sockjs works properly and suppress error in browser ...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~98-~98: You might be missing the article “the” here.
Context: ...olean) } } ``` That's it :). Now Browser should reflect .js along with .css chan...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~100-~100: A comma might be missing here.
Context: ...ding. If by some reason plugin doesn't work you could revert changes and left only ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~100-~100: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ... devServer hmr/inline to true affecting only css files. These plugins are working a...
(ADVERB_REPETITION_PREMIUM)
docs/guides/how-to-use-different-files-for-client-and-server-rendering.md
[uncategorized] ~7-~7: Possible missing comma found.
Context: .... This only works for a top-level entry point such as the entry point for a react-rou...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/i18n.md
[grammar] ~29-~29: Normally, after “try to” a verb is expected.
Context: ...k process as well. Note: if you try to lint before running tests, and you depend on...
(WANT_TO_NN)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...he translations before running the lint command or 2. to run the tests first. 4. If...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/rails-webpacker-react-integration-options.md
[uncategorized] ~157-~157: You might be missing the article “the” here.
Context: ...plugin react-hot-loader/babel with option "safetyNet": false: ``` { "plugi...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/guides/render-functions-and-railscontext.md
[uncategorized] ~42-~42: You might be missing the article “an” here.
Context: ...yAppComponent; ``` --- _This would be alternate API where you have to call React.create...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/guides/tutorial.md
[uncategorized] ~75-~75: You might be missing the article “the” here.
Context: ...t-react-on-rails ``` Note: You can use --database=postgresql option to use Pos...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~368-~368: A comma might be missing here.
Context: ...ample, to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/guides/upgrading-react-on-rails.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nfiguration to a better setup ready for Server Side Rendering. ## Upgrading to v13 ### Br...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~56-~56: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ction that takes only zero or one params and you return a React Element**, often JSX...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ction that takes only zero or one params and you return an Object (_not a React Elem...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ion will be treated as a render function and it can return an Object rather than a R...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~85-~85: Possible missing comma found.
Context: ...ion or class component**. _Migration is needed as the older syntax returned a React El...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...webpack builds should set this value to true or else no CSS link tags are generated....
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~133-~133: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...(https://github.com/rails/webpacker) to setup your Webpack configuration. ```yml def...
(NOUN_VERB_CONFUSION)
[uncategorized] ~144-~144: The preposition “by” seems more likely in this position.
Context: ..._RAILS"] usage. You can get all tracing with either specifying trace at your c...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~145-~145: Possible missing preposition found.
Context: ...des to enable component and other types caching with React on Rails. ## Upgrading to v...
(AI_HYDRA_LEO_MISSING_OF)
[uncategorized] ~160-~160: Possible missing comma found.
Context: ...maps in production. This is 100% a best practice as source maps in production greatly in...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~165-~165: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ndles to bypass the Rails asset pipeline and it's extra minification, enabling you t...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ... your client directory - .gitignore: add /public/webpack/* - Gemfile: bu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ... config/initializers/react_on_rails.rb: - Delete `config.generated_assets_dir...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~178-~178: The verb ‘Replace’ is plural. Did you mean: “replaces”? Did you use a verb instead of a noun?
Context: ...onfig now supplies this information - Replace `config.npm_build_(test|production)_com...
(PLURAL_VERB_AFTER_THIS)
[uncategorized] ~179-~179: A comma might be missing here.
Context: ...commend setting dev_server.hmr to false however since HMR is currently broken. - `clien...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~180-~180: Loose punctuation mark.
Context: ...urrently broken. - client/package.json: bump react_on_rails (I recommend bump...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~225-~225: This phrase is duplicated. You should probably use “Run Run” only once.
Context: ...rade RoR in the client/package.json - Run bundle - Run rails webpacker:install - Run rails webpacker:install:react - Run rails g react_on_rails:install - Move...
(PHRASE_REPETITION)
[style] ~242-~242: This phrase is redundant. Consider using “inside”.
Context: ...toconfig/initializers/react_on_rails.rbto keep your node_modules inside of/client 2. Renamed - config.npm_b...
(OUTSIDE_OF)
[formatting] ~269-~269: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...name,** unless the bundle is server side.: ``` const webpackConfigLoader ...
(DOUBLE_PUNCTUATION_PREMIUM)
[duplication] ~300-~300: Possible typo: you repeated a word.
Context: ...packer.yml - If you are not using the webpacker webpacker setup, be sure to put in `compile: fals...
(ENGLISH_WORD_REPEAT_RULE)
docs/guides/webpack-configuration.md
[uncategorized] ~27-~27: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s very little code needed to get started and you don't need to understand really any...
(COMMA_COMPOUND_SENTENCE)
docs/home.md
[grammar] ~22-~22: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `s...
(NOUN_VERB_CONFUSION)
docs/javascript/angular-js-integration-migration.md
[grammar] ~7-~7: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ave not already done this, then you can setup the ReactOnRails default JS code dire...
(NOUN_VERB_CONFUSION)
[style] ~7-~7: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style.
Context: ...inclusion this way will be no different than using the Rails asset pipeline. However...
(DIFFERENT_THAN)
[uncategorized] ~7-~7: “you” seems less likely than “you’re” (you are).
Context: ...ils asset pipeline. However, so long as you understand how your JavaScript will e...
(AI_HYDRA_LEO_CP_YOU_YOUARE)
docs/javascript/capistrano-deployment.md
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: ...t Make sure ReactOnRails is working in development environment. Add the following to deve...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/javascript/react-helmet.md
[style] ~10-~10: Consider a shorter alternative to avoid wordiness.
Context: ...## Example Here is what you need to do in order to configure your Rails application to wor...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~36-~36: Possible missing comma found.
Context: .....props} />; ``` Or a render-function. Note you can't return just the JSX (React el...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~92-~92: You might be missing the article “an” here.
Context: ...gument it will return a hash instead of HTML string. Note, there is no need to speci...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[grammar] ~93-~93: Did you mean the proper noun or did you want to use it as a verb?
Context: ...rerender" as it would not make sense to use react_component_hash without server rendering...
(HAVE_TWITTER)
docs/javascript/react-router.md
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...dering** and should be only used in the server side bundle. From the [original example in ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/server-rendering-tips.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Your code can't reference document. Server side JS execution does not have access to `d...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...d call setTimout. Here's an example of this which shows the line numbers that end u...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/javascript/webpack-v1-notes.md
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1166 characters long)
Context: ...ment halt if Webpack cannot complete! For more details, see the documentation...
(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~7-~7: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Webpack returning a non-zero error code and you want to see all the errors, rather ...
(COMMA_COMPOUND_SENTENCE)
docs/javascript/webpack.md
[uncategorized] ~5-~5: You might be missing the article “an” here.
Context: ... "Code Splitting", etc You can try out example app, [shakacode/react-webpack-rails-tut...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/misc/doctrine.md
[uncategorized] ~27-~27: Write this as one word if you mean the noun “workout”.
Context: ...on - React on Rails has taken the hard work out of figuring out the JavaScript tooling ...
(WORK_COMPOUNDS)
[grammar] ~27-~27: Using the adverb ‘altogether’ may be more appropriate in this context.
Context: ...u'd have to figure out how to splice it all together. This is where a lot of "JavaScript fat...
(ALTOGETHER)
[uncategorized] ~59-~59: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... from the perspective that it rocks for client side development with Rails, even though it'...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~63-~63: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... ES6 is beautiful. React is beautiful. Client side code written with React plus Redux, ful...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~67-~67: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...for Rails (document/database based with lots of business rules), the tight integration ...
(A_LOT_OF)
[uncategorized] ~67-~67: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on Rails is better than building a pure client side app and separate microservices. Here's ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~71-~71: The adjective “React-driven” is spelled with a hyphen.
Context: ...ws mixing and matching Rails pages with React driven pages, even on the same page. Not every...
(DRIVEN_HYPHEN)
[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p with: - Community suggestions. - New client side tooling, libraries, and techniques. - U...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/misc/style.md
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...n. - Anything additional goes next. ## Client Side JavaScript and React - See the [Shakac...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~39-~39: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...ow a github-flow model where you branch off of master for features. - Before merging a...
(EN_WORDINESS_PREMIUM_OFF_OF)
docs/misc/tips.md
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ht now is prerender: false. NOTE: Server side rendering does not work for some compon...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~11-~11: “React” is a proper noun and needs to be capitalized.
Context: ...nt. - Be sure you can first render your react component client only before you tr...
(A_GOOGLE)
docs/outdated/rails-assets-relative-paths.md
[style] ~67-~67: In American English, abbreviations like “etc.” require a period.
Context: ...nsion of the original file (.png, .jpg, etc). Next we'll set the outputPath for ou...
(ETC_PERIOD)
docs/outdated/rails-assets.md
[uncategorized] ~8-~8: Did you mean: “By default,”?
Context: ...e other term for this is a "digest". > By default the filename of the resulting file is t...
(BY_DEFAULT_COMMA)
docs/outdated/rails3.md
[style] ~3-~3: Consider using a different verb to strengthen your wording.
Context: # Rails 3 - Please let us know if you find any issues with Rails 3. - Rails 3 is c...
(FIND_ENCOUNTER)
[style] ~5-~5: Consider using a different verb to strengthen your wording.
Context: ...not testing it for new releases. If you find an issue, you will have to submit a PR ...
(FIND_ENCOUNTER)
docs/rails/rails-engine-integration.md
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...ture: target destination option for the install generator #459](https://github.com/shak...
(A_INSTALL)
docs/rails/turbolinks.md
[typographical] ~11-~11: It seems that a comma is missing.
Context: ... obsolete. # Using Turbo To configure Turbo the following option can be set: `React...
(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~29-~29: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...reload JavaScript and stylesheets. This definitely can make an app perform better, even if the...
(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...he head element by JavaScript (not only body) on page changes with the correct csrf ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...ag, but if the JS code parsed this from head when several windows were opened, then ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~44-~44: Consider inserting a comma before ‘however’.
Context: ...ecs were not all passing. I didn't look details however, may be it is app code related, not libr...
(HOWEVER_MISSING_COMMA)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ... is app code related, not library code. Anyway it may need additional check because th...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~44-~44: You might be missing the article “a” here.
Context: ... need additional check because there is CSRF helper in ReactOnRails and it need to w...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Tur...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~44-~44: The pronoun ‘it’ requires a third-person verb or a past tense.
Context: ...e is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Turbolinks5...
(HE_NEED)
[uncategorized] ~45-~45: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...to work with Turbolinks5. - Turbolinks5 send requests without the Accept: */* in t...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~81-~81: A comma might be missing here.
Context: ...start(); ``` ### async script loading Generally async script loading can be done like: ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~96-~96: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’.
Context: ...cripts asynchronously you may experience, that your Components are not registered corr...
(COMMA_THAT_NOUN)
docs/release-notes/15.0.0.md
[uncategorized] ~28-~28: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...l hydrate early without waiting for the full page load. This improves performance by elim...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ded. - The force_load configuration make react-on-rails hydrate components imm...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...hes the client, without waiting for the full page load. - If you want to keep the previ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...zers/react_on_rails.rbfile. - If we want to keep the original behavior offorce_lo...
(REP_WANT_TO_VB)
[uncategorized] ~34-~34: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ce_loadconfiguration. - Redux store supportforce_loadoption now and it usesco...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~34-~34: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ux store support force_load option now and it uses config.force_load value as th...
(COMMA_COMPOUND_SENTENCE)
docs/testimonials/resortpass.md
[style] ~3-~3: Consider an alternative adjective to strengthen your wording.
Context: ...ted code that both works and reflects a deep understanding of the technologies and p...
(DEEP_PROFOUND)
[grammar] ~3-~3: “React” is a proper noun and needs to be capitalized.
Context: ...s and standards for our transition to a react on rails application. Just three months...
(A_GOOGLE)
spec/dummy/README.md
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e spec/dummy/client/node_modules to the top level - Be sure to install yarn dependencies ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: dummy-app-integration-tests (oldest)
🔇 Additional comments (244)
docs/javascript/troubleshooting-when-using-webpacker.md (2)
8-10: Improve Readability with Spacing Adjustment
The addition of a blank line immediately after the "Rspec failing with" header improves the clarity and visual separation of content in the document. This enhancement aligns well with best practices for Markdown formatting and overall document readability.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
11-12: Streamline Error Message Formatting
The removal of an unnecessary blank line before the error details creates a more concise and readable error message block. This change helps maintain a clean presentation of diagnostic information without altering the actual content.docs/javascript/webpack-v1-notes.md (1)
10-10: Approved: Improved Section Separation.
The addition of a blank line before the "Entry Points" section enhances the readability and visual separation of content, making the document easier to follow.docs/outdated/rails3.md (1)
4-4: Formatting Consistency CheckThe content on this line:
- Rails 3 is confirmed to work up with versions up to 6.8.x.remains unchanged in meaning. The change appears to be part of the formatting update. No action is needed unless further stylistic improvements are desired.
docs/api/view-helpers-api.md (10)
2-2: Formatting Improvement: Added Blank Line for ReadabilityA new blank line was introduced on line 2. This subtle change improves spacing between the document title and subsequent content, aiding readability.
3-3: Header Consistency: Updated Section HeadingThe header has been updated to "## View Helpers API" on line 3. This change ensures the markdown header follows a consistent style throughout the document.
7-7: Section Separation: Introduced Horizontal RuleThe horizontal rule (
---) added at line 7 visually separates sections, enhancing document structure and making it easier for readers to distinguish between topics.
19-19: Spacing Adjustment: Improved SeparationThe change on line 19 (likely a blank line insertion) improves the separation between the "Uncommonly used options:" heading and the subsequent content. This spacing adjustment enhances overall readability.
42-42: Section Demarcation: Horizontal Rule AdditionA horizontal separator was added at line 42 to delineate the end of one section and the beginning of the "react_component_hash" section. This contributes to a cleaner and more organized layout.
81-81: Visual Clarity: Additional Horizontal RuleThe horizontal rule added at line 81 further segments the document, making the transition between topics clear and aiding readers in navigating the content.
102-102: Section Break: Horizontal Rule for Context TransitionThe inserted horizontal rule at line 102 separates the detailed explanation of
rails_contextfrom the following sections, reinforcing a clean and reader-friendly structure.
112-112: Renderer Functions Separation: Enhanced Document StructuringThe horizontal rule at line 112 after the renderer functions section effectively isolates this segment from subsequent content, increasing clarity.
122-122: Demarcation for React Router Section: Clean SeparationAdding a horizontal rule at line 122 before the React Router section creates a clear division, which helps in visually organizing the document sections.
133-133: Final Section Break: Horizontal Rule Post server_render_jsThe horizontal rule at line 133 sets apart the "server_render_js" discussion from the following content. This final formatting touch supports uniformity across the documentation.
docs/rails/rails-engine-integration.md (3)
3-4: Clarify the Initializer InstructionThe addition of the bullet point
- At the top of \config/initializers/react_on_rails.rb``
provides clear guidance on where to place the initializer code. Please ensure that this styling is consistent with the rest of the document.
11-12: Consistent Instruction for Gem SpecificationThe bullet point
- In your <engine_name>.gemspec:
clearly indicates where to modify the gemspec file. The formatting is clear and aligns well with the document’s style.
17-18: Well-Defined Engine Entry PointThe bullet point
- In your \lib/<engine_name>.rb` (the entry point for your engine)`
precisely instructs the reader on where to include the required code. This enhances clarity and should help reduce confusion during integration.docs/misc/tips.md (1)
5-6: Command Formatting Review
The inline code formatting for theforeman start -f Procfile.devcommand is clear and correctly emphasized.docs/contributor-info/linters.md (1)
2-2: Formatting Improvement on Introduction
The update on line 2 (a whitespace or newline change) helps clean up the document’s layout. Overall, the introductory formatting looks more consistent now.docs/misc/style.md (6)
2-2: Good Use of Added Line BreakThe insertion of a blank line at line 2 helps visually separate the title from the subsequent content, enhancing readability.
5-7: Enhanced Bullet Point Formatting in the Code Style SectionThe added bullet points clearly list the key items (linters, style guide references, and additional notes), which improves the structure. Ensure that punctuation and phrasing remain consistent with the rest of the document.
10-11: Improved Visual Grouping for Client Side JavaScript and ReactAdding a blank line and a bullet point in this section makes the reference to the JavaScript Style Guide stand out better. This enhances clarity for readers.
14-14: Clear Section Separation in “Style Guides to Follow”The new blank line at line 14 provides a better separation for the section heading, which improves the overall readability of the document.
18-20: Improved Readability in Ruby Coding StandardsThe new spacing and bullet points in the Ruby Coding Standards section make the list easier to follow and more visually appealing.
29-30: Consistent Formatting in Git Coding StandardsThe insertion of a blank line and the bullet point in this section improves the document’s structure and aids quick scanning.
docs/additional-details/recommended-project-structure.md (8)
18-18: Improved Header Clarity:
The updated header clearly delineates the conversion steps to use a/clientdirectory, making the section easier to locate and read.
29-29: Configuration Alignment:
Settingsource_path: clientensures the configuration properly reflects the new project structure. Verify that all related references in your tooling are updated accordingly.
37-37: Clarification onpackage.jsonDelegation:
Adding the step to create a delegating/package.jsonclarifies the restructuring process. Consider including an example snippet to aid less experienced users.
44-44: Clear ENV Variable Instruction:
The note on setting theSHAKAPACKER_CONFIGENV variable is helpful, especially with the clarification on the spelling change from Webpacker to Shakapacker.
47-47: Enhanced Section Header Formatting:
The formatting adjustment for the "CSS, Sass, Fonts, and Images" section improves readability.
63-64: Consistent Formatting for Webpack Section:
The additional formatting before the explanation on generating CSS, image, and font assets helps segregate the content in this section clearly. Ensure this style is applied consistently throughout the document.
67-67: Improved Directory Structure Presentation:
The spacing adjustment in the "Directory structure" header aids in visually separating the section, thereby enhancing overall readability.
72-72: Section Header Formatting:
The slight formatting change for the “#### Advantages to having Webpack Manage Styles” header improves content separation and readability.docs/outdated/rails-assets-relative-paths.md (10)
39-41: Prettier Fix: Loader String Formatting
The change from double quotes to single quotes and the addition of a semicolon in the loader configuration (i.e.loader: 'file-loader?name=[name].[ext]';) are consistent with the updated Prettier rules.
45-48: Consistent Query Object Formatting
The updated query block now uses single quotes for the loader name and includes a semicolon at the end (name: '[name].[ext]';), ensuring consistency with the new formatting rules.
63-65: Consistent File Naming Pattern
The file naming pattern (name: '[name][md5:hash].[ext]';) now follows the single-quote convention and includes a semicolon as per Prettier style guidelines.
71-73: OutputPath Formatting Update
TheoutputPathconfiguration now uses single quotes and ends with a semicolon (outputPath: 'webpack-assets/';), which aligns with the overall formatting improvements.
83-85: PublicPath Formatting Consistency
The updatedpublicPath(publicPath: '/assets/webpack-assets/';) adheres to the new formatting standards with single quotes and a terminal semicolon.
135-136: Webpack Entry Formatting
The entry configuration (entry: ['./app/bundles/HelloWorld/startup/registration'],) has been reformatted to align with Prettier’s style. No functional changes are introduced here.
137-140: Relative Path Update in Output Configuration
Thepathproperty (path: '../app/assets/webpack',) now follows consistent formatting. Ensure that this relative path correctly reflects your asset pipeline configuration.
153-156: Closing Braces Alignment
The reformatting of the closing braces and parentheses in theDefinePluginconfiguration (lines 153-156) now matches Prettier's style requirements.
168-174: Imports-Loader Configuration Formatting
The adjustments made to theimports-loaderblock (particularly the closure on line 173) improve the consistency and readability of the options object.
181-186: File-Loader Options Consistency
The updates to the file-loader configuration ensure that bothoutputPathandpublicPathnow use single quotes and include semicolons, which enhances readability and consistency with the Prettier formatting standards.docs/javascript/capistrano-deployment.md (3)
7-7: Refined Code Block Language MarkerThe Ruby code block opening marker has been updated from “
ruby” to “ruby”. This correction ensures that syntax highlighting is applied correctly.
14-14: Enhanced Section SeparationThe insertion of an extra blank line after the instruction “Then run Bundler to ensure Capistrano is downloaded and installed.” improves clarity by separating text from the forthcoming code block.
15-18: Consistent Code Block Formatting for Shell CommandsThe shell code block has been updated to use "```sh" without any extra spacing, ensuring proper syntax highlighting for shell commands. The additional newline following the block further improves the visual organization.
docs/guides/i18n.md (7)
7-10: Ruby Code Block forconfig.i18n_diris Well-FormattedThe code block clearly shows how to set the internationalization directory with an appropriate comment. The formatting and indentation conform to expected standards.
12-18: Ruby Configuration for i18n YAML Directory is ClearThe configuration snippet for
config.i18n_yml_diris properly formatted and includes a helpful comment. It clearly instructs developers on how to override the default YAML file loading behavior.
24-26: Clear Instructions for Development and CI SetupThe added guidance on adjusting startup scripts and ensuring that the locale generation task runs in CI is valuable. It helps prevent issues with linting failures due to missing translations.
37-39: Ruby Safe Load Options Configuration is CorrectThe snippet setting
config.i18n_yml_safe_load_optionsis formatted correctly and demonstrates how to permit additional classes for safe YAML loading. This enhances security when processing YAML files.
44-47: Ruby Configuration for i18n Output Format is AppropriateThe code block setting
config.i18n_output_format = "js"is concise and meets the documentation requirements. Note that while the configuration is clear, a minor typographical check in subsequent comments might be beneficial.
51-58: JavaScript Dependencies Snippet is Clear and ConsistentThe code snippet provided for specifying the minimum supported versions of
intlandreact-intlis well-formatted. The ellipsis in the snippet indicates omitted content, which is acceptable in documentation examples.
84-91: Component Code Block is ClearThe JavaScript snippet demonstrating how to use
defaultMessagesin a component is well-presented. The formatting and structure align with the documentation’s style.docs/guides/file-system-based-automated-bundle-generation.md (7)
7-9: Enhanced Header FormattingThe "Enable nested_entries for Shakapacker" section now benefits from improved spacing, which makes the header and its following text easier to read.
41-47: Improved List IntroductionThe revised formatting in the "Location of generated files" section—particularly the extra spacing before the bullet points—enhances clarity and readability.
48-52: Consistent.gitignoreUpdate FormattingThe updated instructions in the "Update
.gitignorefile" section now stand out clearly, making it easy for developers to know what paths should be ignored.
57-59: Clear Commit Instructions for Server Bundle EntrypointThe formatting modifications in the "Commit changes to server bundle entrypoint" section effectively communicate the required actions. This clarity helps ensure that developers commit the necessary changes.
72-74: Consistent Background Section FormattingThe "Background" subsection now benefits from improved spacing, which aids in distinguishing it from adjacent content.
154-160: Enhanced Layout Example FormattingThe updated ERB code block for "Your layout would now contain:" is well formatted and clearly demonstrates the intended changes.
191-201: Well-Formatted Server Rendering ExampleThe ERB code block demonstrating the use of
react_component_hashis well organized and easy to follow.NEWS.md (3)
3-3: Formatting: Introductory Sentence Updated
The introductory sentence is now italicized, which enhances the visual hierarchy and differentiates it from other headings. Ensure that this styling is consistently applied across similar documentation introductions.
5-7: Formatting: Bullet Point for October 14, 2020
The bullet point for the October 14, 2020 entry now includes a structured line break for the linked text, improving readability. Double-check its rendering in various markdown viewers to ensure the intended presentation is maintained.
29-29: Date Accuracy: Verify Weekday and Date Alignment
The entry on 2016-11-03 references “Thursday, November 10…” Please verify that the day of the week correctly matches the date, as the current combination appears inconsistent.🧰 Tools
🪛 LanguageTool
[inconsistency] ~29-~29: Did you mean to refer to the current year? November 10, 2025 is not a Thursday, but a Monday.
Context: ...) - 2016-11-03: Spoke at [LA Ruby, 7pm, Thursday, November 10 in Venice, CA: "React on Rails: Why, Wh...(EN_DATE_WEEKDAY_CURRENTYEAR)
docs/guides/rails-webpacker-react-integration-options.md (9)
39-46: JSX Arrow Function Formatting
TheHellocomponent’s arrow function is now consistently formatted with parentheses aroundprops. Also, ensure that the variableclockIconis appropriately imported or defined in context.
57-57: Horizontal Rule Consistency
The use of a horizontal rule here helps with visual separation and readability in the document.
69-85: Webpack Configuration for Ignoring Warnings
The updatedcommonWebpackConfigfunction effectively merges the base configuration with additional options—including a regex to ignore warnings for'react-dom/client'. This ensures compatibility with older React versions and looks well formatted.
87-87: Section Separator
The horizontal rule on this line is consistently applied and aids in visually segmenting the documentation.
111-117: React Refresh Webpack Plugin Section Clarity
The section detailing the React Refresh Webpack Plugin now clearly presents the dependency and command sequence for adding it. The updated link and instructions improve readability.
126-130: React Refresh Plugin Imports Update
The revised code block importingReactRefreshWebpackPluginand retrieving theenvironmentimproves clarity and consistency in the configuration.
150-155: React Hot Loader Package Installation Command
The updated command for installingreact-hot-loaderand@hot-loader/react-dom(usingyarn add --dev) is now formatted consistently and clearly presented.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
150-150: Spaces inside code span elements
null(MD038, no-space-in-code)
174-184: React Hot Loader Integration in Entry Point
The diff snippet correctly adds the import for{ hot }fromreact-hot-loader/rootand wraps the exportedAppcomponent withhot(App). This change aligns well with enhancing hot reloading during development.
186-202: Conditional Sass Loader Configuration Adjustment
The changes in the webpack development configuration effectively disable thesourceMapContentsoption for the sass-loader whenmodule.hotis not active. This is a pragmatic tweak for improving development efficiency.🧰 Tools
🪛 LanguageTool
[uncategorized] ~186-~186: You might be missing the article “the” here.
Context: ...k configuration for development so thatsourceMapContentsoption for the sass ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/guides/render-functions-and-railscontext.md (4)
24-36: Enhanced MyAppComponent FormattingThe first example of
MyAppComponentnow uses a multi-line arrow function with an inner closure to return the React component. This clear separation of parameters and the returned component improves readability and aligns with the updated Prettier configuration.
46-57: Consistent Alternative API ExampleThe alternate API example—demonstrating usage of
React.createElement—has been reformatted. The changes (particularly on lines 46, 50, and 53–57) ensure that the function signature and nested JSX are clearly structured and consistent with Prettier’s formatting rules. This reinforces understanding of the two approaches available for defining render-functions.
61-63: Clarified Server Rendering NoteThe updated note (line 63) about potential React browser console warnings when server rendering has been clearly highlighted. This additional clarity helps developers understand that differences in the
serverSidevalue might trigger warnings, ensuring they pay extra attention when setting up server-side rendering.
144-157: Streamlined AppComponentWithRailsContext ExampleThe higher-order component example for
AppComponentWithRailsContextnow exhibits clearer formatting. The changes on lines 146–147, along with the concise spread operator usage in line 157, make the code more readable while effectively demonstrating how to integraterailsContextinto the props.docs/guides/how-to-use-different-files-for-client-and-server-rendering.md (5)
6-7: Formatting: Improved spacing in introductory text.A new blank or adjusted line after the section header ("## A. Using different Entry Points") helps separate the header from the explanatory text. This enhances readability without altering the meaning.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: Possible missing comma found.
Context: .... This only works for a top-level entry point such as the entry point for a react-rou...(AI_HYDRA_LEO_MISSING_COMMA)
12-14: Style Improvement: Added semicolon in the client entry snippet.The line
ReactOnRails.register({ App });now correctly includes a semicolon at the end. This aligns with JavaScript style guidelines and reinforces consistency.
20-22: Style Improvement: Consistent semicolon usage in the server entry snippet.The updated server entry code now shows
ReactOnRails.register({ App });with the appropriate semicolon. This change ensures parity between the client and server examples.
27-28: Formatting: Enhanced header separation for the “Two Options for Using Webpack Resolve Alias” section.The insertion or adjustment at line 28 improves the visual separation and clarity of the section title.
60-62: Formatting: Separation between instructions and code block.The adjustment before the code snippet for updating
webpack/set-resolve.js(line 61) creates a clearer visual break, which aids in readability for those following the guide.docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (12)
9-10: Formatting: Clarified bullet point for hot-reloading.The updated bullet “3. Optional hot-reloading…” now clearly distinguishes the improved approach (using fast-refresh) from outdated practices. This change aids in emphasizing that react-hot-loader is deprecated.
13-14: Emphasis: Improved negation styling for server-side rendering reference.Changing the phrasing to
If you are **_not_** using server-side rendering (**_not_** using `prerender: true`),provides stronger visual emphasis on the condition. This enhances clarity for readers.
20-22: Formatting: Enhanced line breaking for server rendering configuration.The adjustment (inserting a break before “rendering.”) makes the sentence easier to read. Such subtle changes improve the overall presentation.
23-24: Formatting: Clear separation for section header.The change to the header
## If you use the same Webpack setup for your server and client bundlesensures that it stands out as a distinct section.
25-27: Clarity: Improved reference to the initializer configuration.The formatting for the reference
`config/initializers/react_on_rails.rb` setting ofhelps direct attention to the relevant configuration file.
32-35: Formatting: Consistent explanation fordev_serverproperties.By adding a clear separation (i.e. new line at line 34), the explanations for
dev_server.hmranddev_server.inlineare easier to read.
40-42: Formatting: Improved bullet styling for error messages.The error messages are now presented as clearly formatted bullets:
"ReferenceError: window is not defined" (if hmr is true)"TypeError: Cannot read property 'prototype' of undefined" (if inline is true)This adjustment helps developers quickly scan for potential misconfigurations.
44-51: Formatting: Enhanced “Basic installation” steps clarity.The reformatting of the “Basic installation” section (steps for setting properties in
config/shakapacker.yml) improves the visual structure and guides the reader through the setup more naturally.🧰 Tools
🪛 LanguageTool
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...n ## Basic installation To enable HMR functionality you have to use `./bin/shakapacker-dev-...(AI_HYDRA_LEO_MISSING_COMMA)
63-64: Clarity: Updated command for adding react-refresh packages.The new one-line command
yarn add @pmmmwh/react-refresh-webpack-plugin react-refresh -Dis clearly indicated, ensuring that developers can quickly copy and execute the desired command.
66-83: Integration: Well-formatted code block for plugin configuration.The code block demonstrating how to append the
ReactRefreshWebpackPluginwithin the webpack configuration is neatly formatted. This ensures that developers can follow along without ambiguity.
88-95: Clarity: Updated Babel configuration for react-refresh plugin.The Babel config snippet is reformatted clearly, making it evident that the plugin is conditionally applied based on the
WEBPACK_DEV_SERVERenvironment variable. This concise presentation reduces ambiguity.
102-113: Validation: Neatly formatted list of dependencies and versions.The list of plugins and their versions is clearly formatted, which helps developers verify that their environment matches the tested configuration. A quick cross-check with the package files is recommended, but this presentation is effective.
PROJECTS.md (4)
3-3: Link Addition for Public Sites
A new external link has been added to provide a direct search resource for public sites using React on Rails. Please verify that the URL is correct and remains accessible over time.
10-10: Emphasized Support Request
The support request text has been reformatted with italics to increase visual prominence. Ensure that this stylistic choice is in line with the project's documentation guidelines.
41-44: "Open Source Projects Live" Section Formatting Review
The revisions in this section standardize the presentation of project entries. Please ensure all links and descriptions remain current. No significant issues were noted.
54-54: Horizontal Rule Addition
The addition of a horizontal rule provides a clean visual break between sections. This change is clear and beneficial for readability.CONTRIBUTING.md (16)
3-5: Enhanced Contributor Documentation LinksThe bullet list for contributor documentation has been reformatted for clarity. The clear, individual links to the contributing docs improve readability and navigation.
8-11: Improved Formatting in Test InstructionsThe test instructions now clearly present the prerequisite steps (e.g. installing Yalc and preparing examples) with distinct bullet points. This enhances readability and guides contributors better.
37-39: Clearer Test App Configuration InstructionsThe spacing adjustments in the section describing how to configure your test app (using either an external app or the internal
spec/dummy) enhance the overall readability.
49-50: Enhanced Readability for Ruby Gem Testing InstructionsThe brief introduction under "## Testing the Ruby Gem" is now spaced in a way that helps the reader quickly grasp the setup instructions for testing the gem.
59-60: Improved Node Package Testing ClarityThe instructions for testing the node package via Yalc are now clearly formatted. This update should help contributors understand the required steps without confusion.
105-108: Clear Example for Testing NPM ChangesThe added example under "#### Example: Testing NPM changes with the dummy app" is straightforward and clearly illustrates the necessary steps. This should be very helpful for developers verifying client-side updates.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
106-106: Bare URL used
null(MD034, no-bare-urls)
114-116: Improved Prerequisites SectionThe prerequisites section now unambiguously instructs contributors on setting up their environments (RVM, NVM, etc.) and running
bin/setup. This makes the initial setup easier to follow.
121-122: Helpful Side Note on Webpack AliasingThe side note emphasizing the importance of using the webpack alias section to avoid double inclusion errors is a valuable addition that reinforces best practices.
205-209: Clearer Generator Installation InstructionsThe generator installation snippet is now formatted consistently, improving its clarity. Contributors can now more easily add the gem from a local path.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~205-~205: A comma might be missing here.
Context: .... ### Install Generator In your Rails app add this gem with a path to your fork. ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
213-213: Streamlined Main Installer InstructionsThe instruction to run the main installer using
rails generate react_on_rails:installis now clearly highlighted. This concise directive aids quick execution.
230-233: Enhanced Generator Testing GuidanceThe additional details for testing the generator provide useful context and clarity for contributors. This will help in verifying generator functionality more effectively.
236-239: Improved Linting Section ClarityThe linting section now includes a well-structured description and helpful external links (e.g. Docker Toolbox and Docker Compose). This formatting makes the instructions easier to follow.
🧰 Tools
🪛 LanguageTool
[grammar] ~237-~237: The word ‘lint’ is a noun or an adjective. A verb or adverb is missing or misspelled here, or maybe a comma is missing.
Context: ...changes via the lint container. You can lint locally by running `npm run lint && npm...(PRP_MD_NN)
245-255: Consistent Formatting for Linting CommandsThe "Linting Commands" section is formatted in a clear and instructive manner, detailing both direct and Docker-based command usage. This consistency is appreciated.
🧰 Tools
🪛 LanguageTool
[typographical] ~250-~250: Consider adding a comma here.
Context: ...rs. For individual rake linting commands please refer torake -D dockerfor the list....(PLEASE_COMMA)
257-262: Clear Rubocop Update InstructionsThe steps listing the two files that need Rubocop updates are straightforward and clearly highlight the necessary actions. This detail supports maintainability.
264-270: Well-Formatted Docker CI InstructionsThe Docker CI and test instructions now provide clear, step-by-step guidance on building and running containers. This improves the onboarding experience for contributors.
271-276: Informative Section for Maintainers and ContributorsThe final section addressing project maintainers and contributors is well-organized and provides valuable insight into the project's maintenance philosophy.
🧰 Tools
🪛 LanguageTool
[grammar] ~275-~275: If this is a question, the word order is probably incorrect. Did you mean “Why is this”… ?
Context: ...ub.com/turbolinks/turbolinks) repo: > [Why this is not still fully merged?](https://github...(WHY_THE_WORD_ORDER_IS_WRONG)
docs/javascript/angular-js-integration-migration.md (2)
9-9: Clear CSS Modules SectionThe update to the CSS Modules section is clear and improves readability.
27-27: Clear Elaboration on Migration StrategiesThe revised explanation on migration approaches provides a clear, concise overview.
docs/javascript/react-router.md (3)
10-11: Consistent Import FormattingThe import statements now include semicolons and adhere to Prettier styling.
16-19: Clean Code Block in Router ComponentThe formatting changes in the Router component (including the use of
<Switch>{routes}</Switch>) enhance clarity without affecting functionality.
29-33: Consistent Bullet List Formatting for External LinksThe updated bullet list for external resource links follows markdown best practices and is easier to read.
docs/javascript/react-helmet.md (7)
4-4: Installation and Usage Section FormattingThe updated installation guidance (“See [nfl/react-helmet]…”) improves clarity.
8-8: Example Section Introduction UpdatedThe revised introductory sentence in the Example section is clearer and more concise.
32-34: Simplified Component Export is ClearThe updated arrow function export syntax (i.e.
export default (props) => <App {...props} />;) is cleaner and easier to read.
46-51: Non-Working Example ClarificationThe non-working pattern is clearly demonstrated. An explicit note stating that the double-curly syntax is invalid—and a pointer to the correct approach—could help readers further.
🧰 Tools
🪛 LanguageTool
[formatting] ~46-~46: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...ops}} /> ); ``` Note, this doesn't work, because this function just returns a React elem...(COMMA_BEFORE_BECAUSE)
73-78: Registration for Client-side GeneratorThe snippet for registering the client-side generator with ReactOnRails is formatted correctly.
80-87: Registration for Server-side GeneratorThe updated code for registering the server-side generator is clear and adheres to the updated style conventions.
102-107: Incorporating Rendered TitleThe Ruby code snippet showing how to yield the title is clear and well formatted.
docs/misc/doctrine.md (7)
11-13: Consistent Heading Formatting
The heading “## Optimize for Programmer Happiness” is well formatted in line with the updated Prettier settings.
35-38: Enhanced Section Formatting for "The Menu Is Omakase"
The formatting in this section, including the spacing before the chef’s selection introductory line, is now cleaner and more consistent with the overall document style.
39-46: Consistent Library List Formatting
The “### Libraries” section now uses uniform dash bullets. The list is clear and well structured.
47-52: Updated Formatting in "JavaScript Tooling" Section
The bullet list formatting in this section is consistent and improves readability.
55-56: Improved Disclaimer Formatting
The adjusted formatting for the disclaimer “By the way, we're not omakase for standard Rails…” aligns well with the document’s style.
81-84: Solid Formatting in "Raise a Big Tent"
The formatting for “## Raise a Big Tent” and its content is clear and consistent with the rest of the document.
85-88: Consistent Formatting in the "Thanks!" Section
The closing “## Thanks!” section is now well formatted, with improved line breaks and bullet adjustments enhancing its readability.docs/contributor-info/generator-testing.md (3)
2-2: Improved Readability with Blank Line
The added blank line after the header enhances the visual separation of content.
8-8: Enhanced Section Separation
The insertion of a blank line before the "Travis and Gemfiles" header improves readability by clearly delineating sections.
13-13: Improved Readability in Section Transition
The additional blank line preceding the "Configuring what Apps are Generated" section helps in distinguishing the content, making the document easier to scan.docs/contributor-info/pull-requests.md (2)
4-4: Blank Line for Section Spacing
The inserted blank line after the "Checklist before Committing" header enhances readability by providing clear visual separation from the subsequent list.
40-44: Link Formatting Review
The updated formatting for doc and source code URL references is clear and consistent. Please double-check that the URLs are still valid, but no further changes are necessary here.docs/guides/tutorial.md (20)
3-4: Enhance introductory reference formatting.
The italicized text now draws attention to the example repository link in a subtle way.
5-5: Add a horizontal divider for clarity.
The horizontal rule helps to visually separate the introductory note from the rest of the content.
7-8: Update version information with emphasis.
Using italics to highlight “Updated for Ruby 2.7, Rails 7, React on Rails v13, and Shakapacker v7” neatly emphasizes the current technology stack.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
7-7: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
16-18: Improve source links list formatting.
The restructured bullet list for the source code links (including the Redux option and Heroku links) now reads more clearly.
26-26: Refine Table of Contents spacing.
The added spacing (or blank line) after the “Table of Content:” heading improves readability and visual separation from the subsequent list.
48-49: Enhance section spacing.
The inserted blank line before the “## Setting up your environment” header increases clarity in the document’s structure.
60-62: Clarify Rails app creation instructions.
The additional explanation (“Then we need to create a fresh Rails application as follows.”) serves as a helpful introduction to the section.
77-79: Strengthen gem installation section readability.
The spacing adjustment after the “## Add the Shakapacker and react_on_rails gems” header makes the instructions easier to scan.
153-155: Clarify Heroku prerequisites with a contextual note.
The italicized note (“Assuming you can log in to heroku.com and have logged into your shell for Heroku.”) adds useful context for users setting up their Heroku app.
169-171: Standardize Heroku buildpacks commands.
The clearly formatted code block for setting multiple Heroku buildpacks improves the instructional clarity for configuring the build environment.
174-176: Enhance swap-out instructions for SQLite to PostgreSQL.
The formatting update here (via an intervening line) better separates the headline from the explanatory text, improving legibility.
246-263: Confirm puma configuration code block consistency.
The updated puma configuration snippet is clearly delineated, making it easier for developers to verify that their settings align with deployment needs.
266-272: Specify runtime engine versions in package.json.
The added “engines” field clarifies the expected Node and Yarn versions, which aids in maintaining a consistent development environment.
291-292: Strengthen server rendering section header.
The updated header (“## Turning on Server Rendering”) improves the flow and visual hierarchy of the document.
319-328: Verify server rendering HTML snippet formatting.
The formatted HTML block clearly illustrates the difference between non-server and server rendering outputs, which is valuable for developer understanding.
333-334: Enhance additional reading links for server rendering.
The bullet list for further reading (client vs. server rendering and React Server Rendering links) is now clearly formatted for better accessibility.
360-362: Consolidate HMR resource links.
The newly formatted list of HMR-related resources (webpack-dev-server, DevServer, and Hot Module Replacement) offers a concise reference for users.
370-372: Clarify Procfile.dev snippet for custom IP & PORT setup.
Presenting the Procfile.dev content in a dedicated code block helps ensure developers can easily follow the custom configuration instructions.
380-381: Clarify RubyMine exclusion recommendations.
The updated bullet list now clearly identifies which directories (generated files and node_modules) should be excluded to optimize RubyMine performance.
385-386: Refine conclusion call-to-action.
The added bullet point inviting users to “Browse the docs on our documentation website” enhances the concluding remarks.docs/release-notes/15.0.0.md (1)
36-48: Clarify Asynchronous Usage ofreactOnRailsPageLoaded().
The updated section clearly indicates thatReactOnRails.reactOnRailsPageLoaded()is now an async function. The provided code example (with the "Before" and "After" blocks) is useful. Please confirm that all documentation and guidance clearly instruct users to await the function to avoid race conditions.docs/javascript/webpack.md (4)
4-4: Improved Spacing for Readability
The insertion of a blank line immediately after the heading enhances visual separation and overall readability.
8-8: Enhanced Section Separation
The added spacing following the "Webpack v1 or v2?" heading clearly delineates sections, contributing to better document structure.
21-22: Consistent List Formatting
Reformatting the links as a bulleted list using dashes is clear and aligns with Prettier styling guidelines.
25-25: Section Spacing Consistency
The spacing introduced before the "Webpack v4" section improves the document’s structure and readability.docs/getting-started.md (7)
10-10: List Reordering for Logical Sequence
Updating the resource list so that the item previously numbered “3” is now “4” clarifies the intended order. Verify that this change was deliberate.
53-53: Clarification on Runtime Environment
The added note on settingEXECJS_RUNTIME=Nodeis helpful. It clearly informs users about configuring the JavaScript runtime environment.
72-74: Improved Configuration Guidance
The reformatting of configuration instructions into a clear bulleted list enhances clarity. The separation of steps for adjustingreact_on_rails.rbandshakapacker.ymlis especially beneficial.
116-117: JSX Formatting Improvement
The updated JSX snippet clearly separates the displayed locale and greeting. The use of a<br />tag between the two lines adds clarity to the component’s output.
134-137: Module Registration Formatting
The changes in the JavaScript bundle (lines 134–137) provide a clean and explicit registration of theHelloWorldcomponent with ReactOnRails, aligning well with the updated Prettier configuration.
171-171: JSX Function Closure
The closure of the function component on line 171 is now correctly formatted. No further changes are needed here.
194-195: Error Handling Details Formatting
The bullet points detailing error handling now appear clear and well-formatted, outlining both the error type and additional context for server rendering issues.docs/guides/how-react-on-rails-works.md (1)
5-5: Enhanced Explanatory Text
The revised description on line 5 clarifies how Webpack generates bundles directly and bypasses the Rails asset pipeline. This improvement aids in understanding the system architecture.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
5-5: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
docs/guides/client-vs-server-rendering.md (1)
3-3: Consistent Emphasis Markup
The shift from asterisk-based to underscore-based emphasis on line 3 aligns with the overall formatting changes introduced by Prettier, ensuring consistency across the document.spec/dummy/README.md (3)
25-25: Validate the updated Yarn command.
The change to useyarn run dummy:installappears clean. Please verify that this command consistently triggers the intended install process in all environments.
39-41: Proper formatting for static asset loading command.
The code block for runningforeman start -f Procfile.dev-staticis now correctly formatted. Confirm that this command integrates well with deployment and local startup scripts.
44-47: Improved clarity in test asset creation instructions.
Formatting changes in this section enhance readability. Verify that the commandforeman start -f Procfile.specremains accurate relative to your test setup.spec/dummy/client/README.md (8)
3-4: Consistent header formatting for ESLint instructions.
Introducing the# ESLintheader improves the document’s structure. Ensure that this header style is uniformly applied in similar documents.
9-10: Enhanced linter section clarity.
The updated “Running linter:” header and accompanying text now clearly communicate how to execute and autofix linting.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
9-9: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
16-18: Consistent spacing in shell command instructions.
The spacing adjustment before the autofix command (yarn run lint -- --fix) improves readability. Please confirm that the syntax is fully compatible with your tooling environment.
18-20: Header update for dependency management.
The new# Updating Node Dependenciessection clearly separates these instructions from other content. This improves overall document organization.
23-23: Consistent code block spacing.
A minor adjustment to the blank line within the dependency instructions further enhances consistency.
25-29: Clear instructions for updating client dependencies.
The command sequence (includingcd client,npm-check-updates -u -a, andyarn) is now presented in a concise and clear manner.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
25-25: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
25-25: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
39-39: Helpful node_modules cleanup reminder.
The added note to potentially deletenode_modulesis a useful hint for resolving upgrade conflicts.
41-56: Streamlined "Adding Node Modules" section.
The revised section clearly presents the command for adding a dependency and offers an alternative (dev dependency) option. Verify that the list markers and formatting are consistent with project standards.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
50-50: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
docs/home.md (3)
3-11: Consistent list formatting in the Details section.
Using “1.” for each list item is acceptable in Markdown; please ensure this style is consistent elsewhere in the project.
12-16: Clear presentation in the Changes and Upgrades section.
The numbering and links (e.g. to CHANGELOG.md and the upgrade guide) are clear. Verify that all URLs reflect the current documentation status.
23-25: Well-separated "Other Resources" section.
The header and ensuing list now clearly delineate external resources. Confirm that the list style aligns with other similar documentation files.README.md (10)
21-24: Updated News section details.
The revised bullets now succinctly highlight React on Rails Pro, the maintenance ofshakapacker, and the Rails 7 update. The information is current and the dash style is consistent.
25-27: Clear documentation versioning separation.
The horizontal rule and italicized note effectively separate current docs from older versions. This improves navigability and context.
29-33: Enhanced clarity in the About section.
Minor formatting tweaks here streamline the presentation of React on Rails and its maintenance by ShakaCode.
35-37: Strong description of ShakaCode Upgrade Support.
The updated section clearly explains how ShakaCode assists Rails teams with upgrades. The language is clear and service-oriented.
45-47: Detailed presentation of React on Rails Pro benefits.
The section now effectively summarizes features such as webpack optimization, code splitting, and real-world performance improvements (with Popmenu’s metrics). Please verify that all external links remain valid.
67-67: Improved detail on integration features.
The slight reformatting in the “Features and Why React on Rails?” section—particularly the description of tight integration with shakapacker—enhances readability.
77-80: Clear presentation of online demo options.
The bullet-point list for demos is concise and clearly differentiates between the tutorial and the upcoming deployed version. Ensure the deployed link is maintained over time.
81-86: Refined instructions for accessing premium content.
The italic note on account requirements and the bullet list for premium topics are now clearly formatted, aiding user navigation.
101-107: Clear Contributing and Work with Us guidelines.
The call-to-action regarding hiring and the contribution invitation are both prominently and clearly presented. Ensure that the messaging remains up-to-date with recruitment efforts.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
101-101: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
102-102: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
117-151: Overall layout and supporters section formatting.
The subsequent sections with supporter logos and links are well structured. Minor adjustments might be needed for consistent spacing, but the current changes enhance readability and visual appeal.docs/outdated/rails-assets.md (1)
15-17: Readability Improvement: Section SeparationThe added newline (indicated at line 16) before the "The Problem" section helps visually separate the header from the subsequent content. This subtle change enhances the overall readability of the document.
KUDOS.md (19)
14-14: Formatting Update: Adjust Spacing After "## June 9, 2017"
The change on line 14 appears to update the spacing or newline following the June 9, 2017 header. This helps ensure that the section’s visual separation is consistent with the Prettier formatting guidelines.
20-20: Formatting Update: Refine Section Break for "### May 6, 2017"
The update on line 20 consistently adjusts the markdown spacing following the header. Confirm that this change aligns with the overall formatting style across the document.
26-26: Formatting Update: Standardize Spacing for "### April 6, 2017" Section
The change at line 26 refines the spacing after the header. This minor adjustment improves readability and maintains consistency with the updated Prettier rules.
32-32: Formatting Update: Consistent Section Separation for "### March 23, 2017"
The update on line 32 ensures that the spacing following the header is uniform with other sections. The change appears appropriate under the new formatting settings.
38-38: Formatting Update: Update Spacing for "### March 21, 2017"
The change on line 38 appears to adjust the section break after the header. This improves visual consistency and adheres to the repository’s formatting standards.
44-44: Formatting Update: Adjust Spacing After "### March 2, 2017"
The update on line 44 refines the whitespace following the header to improve overall document consistency.
53-53: Formatting Update: Standardize Section Header "### December 20, 2016"
The change on line 53 is a formatting adjustment that improves the consistency of section breaks.
57-57: Formatting Update: Consistent Separation for "### December 12, 2016"
The update on line 57 adjusts the spacing after the header, aligning with the updated Prettier rules across the document.
61-61: Formatting Update: Enhance Section Break for "### November 15, 2016"
The modification on line 61 refines the spacing following the header, ensuring a consistent appearance throughout the file.
65-65: Formatting Update: Refine Spacing for "### November 9, 2016, in our Slack Room for ShakaCode"
The updated spacing on line 65 improves the visual clarity and separation of the header from its content.
69-69: Formatting Update: Adjust Section Spacing for "### November 6, 2016"
The change on line 69 standardizes whitespace following the header. This subtle update is in line with Prettier’s formatting enhancements.
74-74: Formatting Update: Standardize Section Header "### October 29, 2016"
The update on line 74 adjusts the spacing for the header, and ensures uniform formatting with the other sections in the file.
79-79: Formatting Update: Update Spacing for "### September 11, 2016"
The change on line 79 appears to fine-tune the whitespace following the section header, contributing to a consistent markdown layout.
83-83: Formatting Update: Maintain Uniformity in "### August 9, 2016" Section
The adjustment on line 83 helps reinforce a consistent look across all sections.
87-87: Formatting Update: Consistent Section Spacing for "### June 15, 2016"
The update on line 87 refines the spacing following the header, ensuring consistency with the repository’s overall markdown style.
90-90: Formatting Update: Improve Separation Before "### May 11, 2016"
The change on line 90 appears to add or adjust a separator (such as a newline), enhancing the visual break before the next section header.
91-91: Formatting Update: Standardize Header "### May 11, 2016"
The update on line 91 refines the header’s formatting in line with the other section headers, contributing to document-wide consistency.
97-97: Formatting Update: Adjust Spacing for "### May 10, 2016"
The change on line 97 is a minor formatting tweak that aligns the section break with the revised Prettier settings.
111-111: Formatting Update: Enhance Presentation for "### March 23, 2016, Compared to Browserify"
The update on line 111 adjusts the spacing, which helps maintain visual clarity in the timeline. This minor change contributes positively to the overall readability of the file.docs/rails/turbolinks.md (9)
11-12: Inline Code Formatting is Clear.
The code snippetReactOnRails.setOptions({ turbo: true })is well formatted. Just ensure that this style is consistent throughout the document.🧰 Tools
🪛 LanguageTool
[typographical] ~11-~11: It seems that a comma is missing.
Context: ... obsolete. # Using Turbo To configure Turbo the following option can be set: `React...(IN_ORDER_TO_VB_COMMA)
60-64: Verify JavaScript Inclusion Example.
The snippet showing Turbolinks inclusion via//= require turbolinksis concise and clear. Make sure that its context is properly explained elsewhere in the documentation.
65-69: Clear Statement on Turbolinks 5 Support.
The section succinctly explains that React on Rails now supports Turbolinks 5 with automatic event handler selection. No further action needed unless additional technical details are warranted elsewhere.
75-79: Validate ES6 Import Snippet.
The JavaScript snippet using ES6 syntax (import Turbolinks from 'turbolinks'; Turbolinks.start();) is well formatted. Ensure consistency with other module import practices as described in the documentation.
80-88: Async Script Loading Section Review.
The changes in this section, including the example using theasyncattribute, enhance clarity. The explanation is clear; just double-check that the phrasing aligns with best practices in the rest of the doc.🧰 Tools
🪛 LanguageTool
[uncategorized] ~81-~81: A comma might be missing here.
Context: ...start(); ``` ### async script loading Generally async script loading can be done like: ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
104-112: Troubleshooting Section is Well Structured.
The instructions for turning on Turbolinks event tracing and the accompanying code snippet are clear. Adding a brief note on how these debug logs benefit troubleshooting might further assist users.
115-129: Webpack Configuration Guidance is Clear.
The instructions for defining thedevBuildconstant and configuring theDefinePluginwithTRACE_TURBOLINKSare well explained. Verify that these snippets integrate smoothly into your actual Webpack configuration file.
132-142: Console Message Examples for Turbolinks Classic.
The examples detailing the console output for classic Turbolinks are clear and informative. Ensure that these examples accurately reflect the output in different environments.
143-148: Console Message Examples for Turbolinks 5.
The additional console outputs for Turbolinks 5 effectively illustrate the difference in event handlers compared to classic Turbolinks.docs/guides/upgrading-react-on-rails.md (20)
3-5: Migration Help Section AddedA new "Need Help Migrating?" section is added with contact details for support. Please verify that the email and support link are correct and up to date.
11-13: Breaking Change DocumentationThe "Breaking Change" section now clearly notes that the gem dependency has shifted from webpacker to shakapacker. This helps set expectations for users who are upgrading.
25-29: Recent Versions Section AddedA new subheading ("### Recent versions") and accompanying text ensure that users are aware that Rails and webpacker need to be current. This added context is helpful.
33-36: Removed Configuration NoticeThe removal of
config.symlink_non_digested_assets_regexis clearly stated with appropriate instructions. Consider, if applicable, linking to further documentation on alternatives.
102-104: Illustration of a Broken ExampleThe broken example clearly demonstrates what not to do when returning a JSX literal. It might be helpful to add a brief note indicating that this code is intentionally faulty to prompt users to avoid this mistake.
115-117: Corrected Example VerificationThe corrected arrow function example now correctly wraps the returned component. This example is clear and should help users properly migrate their code.
164-165: Incomplete Sentence in Webpacker IntegrationThe sentence in the "Integrating Webpacker" section appears truncated ("enabling you t..."). Please review and ensure the complete sentence is provided to avoid confusion.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~165-~165: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ndles to bypass the Rails asset pipeline and it's extra minification, enabling you t...(COMMA_COMPOUND_SENTENCE)
170-181: Maintaining Your Client Directory InstructionsThe list of instructions for maintaining your
clientdirectory is comprehensive and well formatted. No issues were detected.🧰 Tools
🪛 LanguageTool
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ... yourclientdirectory -.gitignore: add/public/webpack/*-Gemfile: bu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ...config/initializers/react_on_rails.rb: - Delete `config.generated_assets_dir...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~178-~178: The verb ‘Replace’ is plural. Did you mean: “replaces”? Did you use a verb instead of a noun?
Context: ...onfig now supplies this information - Replace `config.npm_build_(test|production)_com...(PLURAL_VERB_AFTER_THIS)
[uncategorized] ~179-~179: A comma might be missing here.
Context: ...commend setting dev_server.hmr to false however since HMR is currently broken. - `clien...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~180-~180: Loose punctuation mark.
Context: ...urrently broken. -client/package.json: bumpreact_on_rails(I recommend bump...(UNLIKELY_OPENING_PUNCTUATION)
182-184: Client Webpack Config HeaderThe added header ("###### Client Webpack config:") and the introductory text clearly mark the start of the configuration section. Looks good.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
182-182: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
195-203: Webpack Output ConfigurationThe code snippet showing the webpack output rules is clear and concise. The comments about using hash or chunkhash for cache busting are useful.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
197-197: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
205-213: ManifestPlugin ConfigurationThe updated ManifestPlugin configuration snippet is correctly formatted and clearly demonstrates how to use the plugin with your webpack output settings.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
207-207: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
215-216: Asset Referencing InstructionsThe instructions regarding updating
publicPathfor file loaders are clear. It might be useful to double-check that these instructions remain valid for the latest versions ofurl-loaderandfile-loader.
221-232: Integration Upgrade StepsThe extended list of upgrade steps—including bundle installations, webpacker installations, and directory changes—is very thorough. This detailed checklist should assist users in seamlessly completing the upgrade.
🧰 Tools
🪛 LanguageTool
[grammar] ~225-~225: This phrase is duplicated. You should probably use “Run Run” only once.
Context: ...rade RoR in theclient/package.json- Runbundle- Runrails webpacker:install- Runrails webpacker:install:react- Runrails g react_on_rails:install- Move...(PHRASE_REPETITION)
245-246: Renaming Build CommandsThe renaming of
config.npm_build_test_commandandconfig.npm_build_production_commandto the new build commands is clear and self-explanatory.
256-265: WebpackConfigLoader Property RenamesThe list of property renames (e.g.,
webpackOutputPathtooutput.path, etc.) is well documented. These changes are clearly explained and match the upgraded configuration requirements.
268-285: Updated Webpack Output Configuration ExampleThe webpack output configuration snippet demonstrates the proper use of hashed filenames and other options. This example is clear and should be useful in practice.
🧰 Tools
🪛 LanguageTool
[formatting] ~269-~269: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...name,** unless the bundle is server side.: ``` const webpackConfigLoader ...(DOUBLE_PUNCTUATION_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
271-271: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
286-295: ManifestPlugin Snippet RevisionThe revised ManifestPlugin configuration is presented clearly in this new example. It is easy to follow and matches the updated webpack output settings.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
289-289: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
297-320: Updated Webpacker Configuration InstructionsThe lengthy section on updating the webpacker configuration—including renaming files, setting default values, and modifying environment-specific settings—is very thorough. The instructions are detailed and consistent with the project’s formatting guidelines.
🧰 Tools
🪛 LanguageTool
[duplication] ~300-~300: Possible typo: you repeated a word.
Context: ...packer.yml - If you are not using the webpacker webpacker setup, be sure to put in `compile: fals...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~319-~319: You might be missing the article “the” here.
Context: ...dummy/config/webpacker.yml. - Remove keyshot_reloading_hostandhot_reloading...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
299-299: Bare URL used
null(MD034, no-bare-urls)
303-303: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
307-307: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
311-311: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
321-324: Procfile.dev UpdateThe changes to the Procfile.dev (removing the unused
WEBPACKER_DEV_SERVERenv value and setting hot loading keys) are clear and concise.🧰 Tools
🪛 LanguageTool
[uncategorized] ~323-~323: Possible missing comma found.
Context: ... - Remove the env value WEBPACKER_DEV_SERVER as it's not used - For hot loading: ...(AI_HYDRA_LEO_MISSING_COMMA)
327-333: Non-Integrated Webpacker Upgrade InstructionsThe final instructions for projects not using integrated webpacker are complete and well organized. They provide a clear roadmap for updating both the Gemfile and initializer settings.
| #### The seven rules of a great git commit message | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Adjust Heading Level for Consistency
The header “#### The seven rules of a great git commit message” skips a heading level relative to its context. Adjusting it to “### The seven rules of a great git commit message” ensures a consistent heading increment.
-#### The seven rules of a great git commit message
+### The seven rules of a great git commit message📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| #### The seven rules of a great git commit message | |
| ### The seven rules of a great git commit message |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
22-22: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
There was a problem hiding this comment.
@alexeyr-ci check this comment
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
There was a problem hiding this comment.
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
2 times, most recently
from
1fcae62 to
9e10930
Compare
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
from
9e10930 to
052a59d
Compare
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (118)
docs/deployment/elastic-beanstalk.md (1)
47-47: Capitalize "React" for Proper Noun ConsistencyThe text refers to "the react app javascript files" using a lowercase "react." Since React is a proper noun, please change it to "React" for consistency and correctness.
🧰 Tools
🪛 LanguageTool
[grammar] ~47-~47: “React” is a proper noun and needs to be capitalized.
Context: ...ic beanstalk successfully. However, the react app javascript files are under `public/...(A_GOOGLE)
docs/testimonials/resortpass.md (1)
3-3: Capitalization and Style ImprovementsThe merged paragraph now reads as a single block of text, which is acceptable under the new Prettier formatting rules. However, note that within this paragraph the phrase “transition to a react on rails application” should have “React on Rails” properly capitalized, as "React" is a proper noun. Additionally, consider whether a stronger adjective might further enhance the description, as suggested by static analysis. This is a nitpick and entirely optional.
[grammar]🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Consider an alternative adjective to strengthen your wording.
Context: ...ted code that both works and reflects a deep understanding of the technologies and p...(DEEP_PROFOUND)
[grammar] ~3-~3: “React” is a proper noun and needs to be capitalized.
Context: ...s and standards for our transition to a react on rails application. Just three months...(A_GOOGLE)
docs/guides/how-react-on-rails-works.md (2)
5-5: Ensure consistent markdown emphasis style.The modified line uses underscores (recommended) for emphasis, but markdownlint (MD049) expects asterisks. To maintain consistent styling across the repository, consider replacing underscores with asterisks.
Suggested change:
-... use the standard Webpack configuration (_recommended_) or the `shakapacker` setup for Webpack. +... use the standard Webpack configuration (*recommended*) or the `shakapacker` setup for Webpack.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
5-5: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
38-38: Visual separation improvement with inserted blank line.The newly added blank line before the numbered list helps improve readability by clearly separating the introductory text from the steps that follow. This change is stylistically sound; just ensure it aligns with your documentation style guidelines.
docs/javascript/webpack-v1-notes.md (1)
7-7: Stylistic Improvement: Refine Punctuation & Exclamation MarksConsider reducing the number of exclamation marks and adjusting punctuation for improved readability. For example, replacing the exclamation point after "complete" with a period and adding a comma before the coordinating conjunction in the latter part of the paragraph can help clarify the sentence structure.
Proposed diff:
-For your scripts that statically build your Webpack bundles, use the `--bail` option. This will ensure that CI and your product deployment **halt** if Webpack cannot complete! For more details, see the documentation for [Webpack's `--bail` option](https://webpack.js.org/configuration/other-options/#bail). Note, you might not want to use the `--bail` option if you just want to depend on Webpack returning a non-zero error code and you want to see all the errors, rather than only the first error. +For your scripts that statically build your Webpack bundles, use the `--bail` option. This will ensure that CI and your product deployment **halt** if Webpack cannot complete. For more details, see the documentation for [Webpack's `--bail` option](https://webpack.js.org/configuration/other-options/#bail). Note, you might not want to use the `--bail` option if you just want to depend on Webpack returning a non-zero error code, and you want to see all the errors, rather than only the first error.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1166 characters long)
Context: ...ment halt if Webpack cannot complete! For more details, see the documentation...(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~7-~7: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Webpack returning a non-zero error code and you want to see all the errors, rather ...(COMMA_COMPOUND_SENTENCE)
docs/misc/tips.md (1)
9-12: Improve Grammar and Consistency in Rendering Tips.
Please consider the following adjustments for clarity and consistency:
- On line 9, change “Server side rendering” to “server-side rendering” to correctly form the compound adjective.
- On line 11, update “react component” to “React component” to respect the proper noun.
A suggested diff for these changes:
- - The default for rendering right now is `prerender: false`. **NOTE:** Server side rendering does not work for some components that use an async setup for server rendering. You can configure the default for prerender in your config. + - The default for rendering right now is `prerender: false`. **NOTE:** Server-side rendering does not work for some components that use an async setup for server rendering. You can configure the default for prerender in your config.- - Be sure you can first render your react component **client only** before you try to debug server rendering! + - Be sure you can first render your React component **client only** before you try to debug server rendering![grammar]
🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ht now isprerender: false. NOTE: Server side rendering does not work for some compon...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~11-~11: “React” is a proper noun and needs to be capitalized.
Context: ...nt. - Be sure you can first render your react component client only before you tr...(A_GOOGLE)
docs/guides/i18n.md (3)
29-29: Consider Revising Linting Note Phrasing
The note regarding linting might benefit from clearer wording. For instance, consider:"Note: Running linting before executing tests may fail if translations have not been built yet using the test helper."
This minor change could enhance clarity.🧰 Tools
🪛 LanguageTool
[grammar] ~29-~29: Normally, after “try to” a verb is expected.
Context: ...k process as well. Note: if you try to lint before running tests, and you depend on...(WANT_TO_NN)
31-34: Review Bullet List Phrasing
The bullet list effectively distinguishes the two solutions. As a readability improvement, consider adding a comma after "lint command" in option 1. For example:
- run the rake task to build the translations before running the lint command, or
- run the tests first.
This adjustment could further streamline the instructions.🧰 Tools
🪛 LanguageTool
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...he translations before running the lint command or 2. to run the tests first. 4. If...(AI_HYDRA_LEO_MISSING_COMMA)
62-82: React-Intl Initialization is Well-Presented
The code snippet detailing the initialization ofreact-intlis clear and well-structured. As a small improvement, consider correcting the typo in the comment from "Initizalize" to "Initialize" to maintain professionalism.docs/outdated/rails-assets.md (3)
3-3: Emphasis vs. Heading for Important Note: The italicized note on line 3 draws attention to the need for updating the document for Shakapacker/rails‑webpacker usage. However, markdownlint (MD036) recommends using a proper heading rather than mere emphasis for such important notices. Consider using a header (e.g.,### Note:) or a callout block to enhance visibility.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
8-9: Punctuation in Blockquote: The blockquote beginning on line 8 would benefit from a slight punctuation adjustment. Adding a comma after "By default" (i.e. “By default, the filename…”) improves readability and aligns with style guidelines.🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: Did you mean: “By default,”?
Context: ...e other term for this is a "digest". > By default the filename of the resulting file is t...(BY_DEFAULT_COMMA)
37-38: Clarified Note Formatting: The note regarding the removal of the symlink solution in v14 is clearly stated. To further emphasize its importance, you might consider using an alternative formatting style (like a callout or warning block) instead of italics.docs/javascript/capistrano-deployment.md (2)
1-5: Improve Instruction Clarity & Grammar in Introductory Text
There is a minor grammatical ambiguity on line 3 and line 5. Consider revising:
- Line 3: Instead of "Make sure ReactOnRails is working in development environment," consider "Make sure ReactOnRails is working in the development environment."
- Line 5: The sentence "Add the following to development your Gemfile and bundle install." can be rephrased to "Add the following to your Gemfile under the development group and run bundle install."
These adjustments improve clarity and readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: ...t Make sure ReactOnRails is working in development environment. Add the following to deve...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
25-26: Clarify Deployment Memory Note
The note regarding potential deployment delays due to memory constraints is informative. For enhanced clarity, consider rephrasing it as:
"If deployment takes too long or gets stuck during the assets:precompile stage, it might be due to insufficient memory. Webpack can be memory-intensive, so increasing your server’s RAM might help."
This makes the recommendation a bit more direct.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: A comma might be missing here.
Context: ...se of memory. Webpack consumes a lot of memory so if possible, try increasing the RAM ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/rails/rails-engine-integration.md (4)
3-4: Formatting Clarity for Initializer Instruction:
The removal of the leading hyphen before “At the top ofconfig/initializers/react_on_rails.rb” appears to be an intentional formatting change. Please verify that this revised presentation still clearly indicates to users where to add the code in their initializer, ensuring the instruction is prominent and unambiguous.
11-12: Improved Instruction Format for Gem Specification:
The bullet marker preceding “In your<engine_name>.gemspec:” has been removed. This change streamlines the text, but please confirm that the instruction remains clearly set apart from the surrounding content so users easily locate this step.
17-18: Reformatted Engine Entry Point Instruction:
Removing the dash from “In yourlib/<engine_name>.rb(the entry point for your engine)” contributes to a cleaner layout. Ensure that this step is still immediately recognizable for users integrating the gem into their engine and that no context is lost due to the change in formatting.
35-38: GitHub Issues Links Formatting:
The diff removes the bullet points for the list of GitHub issue links. Please confirm that the removal does not reduce the clarity or discoverability of these valuable references. If appropriate, consider reformatting the links (for example, as a numbered list or inline links) to maintain consistency with your overall documentation style.🧰 Tools
🪛 LanguageTool
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...ture: target destination option for the install generator #459](https://github.com/shak...(A_INSTALL)
docs/outdated/rails3.md (1)
3-5: Enhance Wording for Clarity and EngagementThe revised lines introduce a slightly softer tone. However, consider using stronger, more assertive verbs to improve clarity and encourage proactive feedback. For example, on line 3, replacing "Please let us know" with "Please report" offers a more direct call-to-action. Similarly, on line 5, rephrasing "submit a PR" to "contribute a pull request" can help foster a more collaborative tone.
Below is a suggested diff:
- Please let us know if you find any issues with Rails 3. + Please report any issues you encounter with Rails 3. - We are not testing it for new releases. If you find an issue, you will have to submit a PR to get it fixed. + We are not testing it for new releases. If you encounter an issue, please consider contributing a pull request.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Consider using a different verb to strengthen your wording.
Context: # Rails 3 - Please let us know if you find any issues with Rails 3. - Rails 3 is c...(FIND_ENCOUNTER)
[style] ~5-~5: Consider using a different verb to strengthen your wording.
Context: ...not testing it for new releases. If you find an issue, you will have to submit a PR ...(FIND_ENCOUNTER)
docs/additional-details/manual-installation-overview.md (2)
3-5: Verify Consistency in Blank Line Removal.The PR summary mentions that a blank line between the "TODO: Review this file" line (line 3) and the following summary line (line 5) was removed. In the current file, a blank line still appears at line 4. Please confirm if this blank line should be removed to maintain consistency with the intended formatting updates.
21-22: Enhance Grammatical Clarity in Gem Instruction.On lines 21–22, the instruction for adding the
gem "webpacker"would be clearer with improved punctuation and verb agreement. Consider inserting a comma before "which" and changing "is used" to "are used" to read as follows:-1. Add `gem "webpacker"` to the Gemfile, run bundle. The gem provides the `stylesheet_pack_tag` and `javascript_pack_tag` helpers which is used to load the bundled assets to your layouts.[Dummy Example](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/app/views/layouts/application.html.erb) +1. Add `gem "webpacker"` to the Gemfile, run bundle. The gem provides the `stylesheet_pack_tag` and `javascript_pack_tag` helpers, which are used to load the bundled assets to your layouts.[Dummy Example](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/app/views/layouts/application.html.erb)These adjustments align with the static analysis hints and enhance the overall readability.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...eet_pack_tagandjavascript_pack_tag` helpers which is used to load the bundled asset...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...andjavascript_pack_taghelpers which is used to load the bundled assets to your...(AI_HYDRA_LEO_CPT_IS_ARE)
docs/contributor-info/linters.md (2)
10-11: Consider Revising Phrasing for Clarity:
In the RuboCop instruction, the phrase “be in the right directory” is used. As similar language appears later for ESLint, consider substituting with an alternative (e.g., “correct directory” or “appropriate directory”) to avoid repetition and improve clarity.
68-71: Verify Useful Reference Links for Consistency:
The bullet list for Useful Reference Links has been reformatted for clarity. Please verify that the ESLint-related links are not redundant unless each serves a distinct purpose (e.g., one as a quick start guide and the other as general documentation).🧰 Tools
🪛 LanguageTool
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ... Useful Reference Links - Configuring ESLint - [ESLint quick start](http://untilfalse.com/esli...(ENGLISH_WORD_REPEAT_RULE)
docs/javascript/angular-js-integration-migration.md (2)
6-6: Grammar and Style Corrections in Assets Handling SectionIn this paragraph, consider the following enhancements:
- Change the verb form “setup” to “set up” (i.e. “then you can set up the...”).
- Update “no different than” to “no different from” for improved formality.
-... then you can setup the `ReactOnRails` default JS code directory of `/client` to load the JS libraries related to AngularJS, etc. You can configure Webpack to globally export these libraries, so inclusion this way will be no different than using the Rails asset pipeline. ... +... then you can set up the `ReactOnRails` default JS code directory of `/client` to load the JS libraries related to AngularJS, etc. You can configure Webpack to globally export these libraries, so inclusion this way will be no different from using the Rails asset pipeline. ...
27-27: Subject-Verb Agreement in Migration Approach DetailsThe sentence in the migration approach section currently reads “Frequent deploys with incremental parts of AngularJS replaced by React allows smaller incremental deploys...”. Since “deploys” is plural, consider using “allow” instead of “allows” to maintain correct subject-verb agreement.
-1. Frequent deploys with incremental parts of AngularJS replaced by React allows smaller incremental deploys and easier regression analysis should something break. +1. Frequent deploys with incremental parts of AngularJS replaced by React allow smaller incremental deploys and easier regression analysis should something break.docs/javascript/server-rendering-tips.md (2)
5-13: General Tips Formatting & Language Suggestion
The formatting adjustments in the "General Tips" section improve readability. As a nitpick, consider using a hyphen in the compound adjective “Server-side” instead of “Server side” in the bullet point to better adhere to standard English conventions. For example:- Your code can't reference `document`. Server side JS execution does not have access to `document`, + Your code can't reference `document`. Server-side JS execution does not have access to `document`,🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Your code can't referencedocument. Server side JS execution does not have access to `d...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...the view helper applies to client and server side code, the best way to do this is to use...(EN_COMPOUND_ADJECTIVE_INTERNAL)
27-30: Typo Correction & Punctuation Review in setTimeout Section
There appears to be a typo in the explanation: “setTimout” should be corrected to “setTimeout”. Additionally, review the punctuation around this sentence to ensure clarity—static tools suggest that a comma might be needed after the phrase mentioning babel-polyfill. For clarity, consider the following change:- In the past, some libraries, namely babel-polyfill, did call setTimout. + In the past, some libraries, namely babel-polyfill, did call setTimeout.🧰 Tools
🪛 LanguageTool
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...d call setTimout. Here's an example of this which shows the line numbers that end u...(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/tutorial.md (2)
75-75: Grammatical Consistency in Database Option Note
Static analysis suggests that the article “the” might be missing before the--database=postgresqloption. Consider updating the line for improved grammatical clarity.-Note: You can use `--database=postgresql` option to use Postgresql for the database. +Note: You can use the `--database=postgresql` option to use Postgresql for the database.🧰 Tools
🪛 LanguageTool
[uncategorized] ~75-~75: You might be missing the article “the” here.
Context: ...t-react-on-rails ``` Note: You can use--database=postgresqloption to use Pos...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
367-368: Punctuation Suggestion for Cloud9 Example Explanation
A static analysis hint noted that a comma might be missing in the explanatory sentence regarding the Cloud9 IDE setup. A slight adjustment—adding a comma after “free Cloud9 IDE”—could improve clarity.-For example, to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080. +For example, to be able to run on free Cloud9 IDE, we are putting IP 0.0.0.0 and PORT 8080.🧰 Tools
🪛 LanguageTool
[uncategorized] ~368-~368: A comma might be missing here.
Context: ...ample, to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/misc/style.md (2)
23-27: Consistent formatting for JavaScript Coding Standards.
The bullet list for "### JavaScript Coding Standards" is well formatted. Additionally, consider verifying the capitalization of "JavaScript" (currently “Javascript” in one bullet) for consistency.
38-41: Git Usage section wording and formatting suggestions.
The reformatted bullet points improve the section’s readability. For further clarity, consider revising the phrase “branch off of master” (line 39) to “branch from master” as it is more concise.🧰 Tools
🪛 LanguageTool
[style] ~39-~39: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...ow a github-flow model where you branch off of master for features. - Before merging a...(EN_WORDINESS_PREMIUM_OFF_OF)
PROJECTS.md (4)
10-10: Stylized Support Statement Update
The support statement has been updated to use italics, which improves visual emphasis. Consider inserting a comma after “React on Rails” (e.g., “…use React on Rails, as the source…”) to enhance readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...You can confirm a project uses React on Rails as the source will contain **`js-react-...(AI_HYDRA_LEO_MISSING_COMMA)
14-29: Commercial Products List – Minor Grammar and Spelling Suggestions
Several list items in the “Commercial Products Live” section were added. A few minor adjustments are recommended:
- At line 15, consider adding the article “a” so that it reads “a Canadian shopping site.”
- At line 22, add “a” before “large French crowdfunding platform.”
- At line 29, standardize the spelling by using “multilingual” instead of “multi-lingual.”
These changes will improve the consistency and grammatical correctness of the list.🧰 Tools
🪛 LanguageTool
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...eals](https://www.redflagdeals.com/)**, Canadian shopping site. - **[YourMechanic](https...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~22-~22: You might be missing the article “a” here.
Context: ...](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. - **[HVMN...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~29-~29: This word is normally spelled as one.
Context: ...has gone live with React on Rails, with multi-lingual JavaScript support! ![2016-05-03_19-1...(EN_COMPOUNDS_MULTI_LINGUAL)
52-52: Heading Trailing Punctuation
The heading “## Per Github.” contains a trailing period that violates markdown lint rule MD026. Please remove the period so that it reads “## Per Github”.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
52-52: Trailing punctuation in heading
Punctuation: '.'(MD026, no-trailing-punctuation)
57-61: Compound Adjective Consistency in Project List
In the “Projects Based on React on Rails” section, consider hyphenating compound adjectives for clarity. For instance, on line 61, the description “Open source marketplace platform” might be better rendered as “open-source marketplace platform.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ps://github.com/sharetribe/sharetribe): Open source marketplace platform.(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/rails-webpacker-react-integration-options.md (5)
10-14: Review Table Formatting: Inconsistent Column CountThe table header row shows eight columns (with an extra trailing column header " --- ") while the subsequent data rows appear to have only seven columns. Please verify the intended number of columns and adjust either the header or the data rows to ensure consistent Markdown table formatting.
39-47: Review Hello Component Snippet: Clear Arrow Function SyntaxThe use of parentheses around
propsin the arrow function improves clarity and is consistent with modern best practices. If this snippet is intended to be executable, consider adding an import statement or a note regarding the definition ofclockIconto avoid confusion.
50-54: Review Render Component Snippet: Consider Error HandlingThe code snippet for rendering the component correctly demonstrates retrieving an element and parsing its
dataattribute withJSON.parse. For improved robustness, you might consider checking thatdocument.getElementById('hello-react')does not returnnullbefore using it. This would serve as a helpful reminder for users copying this sample in real-world applications.
174-184: Review React Hot Loader Diff Example: Valid JSX and Clear Placeholder UsageThe diff correctly shows the inclusion of
react-hot-loader/rootby adding the import and wrapping the default export withhot(App). Ensure that the placeholder<SomeComponent(s) />in the example component is either replaced with valid JSX or clearly marked as a demonstration-only element, so users know to customize it for their application.
156-159: Review Babel Config Instruction: Minor Language ImprovementConsider revising the phrase "Add the plugin
react-hot-loader/babelwith option"safetyNet": false" to "Add the pluginreact-hot-loader/babelwith the option"safetyNet": false" for improved clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~157-~157: You might be missing the article “the” here.
Context: ...pluginreact-hot-loader/babelwith option"safetyNet": false: ``` { "plugi...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
159-159: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
KUDOS.md (4)
47-51: Tone in User Quote – Consider Refining Informal LanguageIn the quote beginning at line 49, the word "awesome" may come off as too informal given our documentation tone. Consider using a more formal alternative if consistent with overall style guidelines.
🧰 Tools
🪛 LanguageTool
[style] ~49-~49: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ators are great and the community is so awesome and welcoming. In fact, I love it so mu...(AWESOME)
[grammar] ~49-~49: “React” is a proper noun and needs to be capitalized.
Context: ...Rails](https://goo.gl/uzu36X) using the react_on_rails gem!" ).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
70-70: Bare URL used
null(MD034, no-bare-urls)
106-106: Wrap Bare URL in Markdown Link FormatThis bare URL should be converted to a proper Markdown link. For example, you might use
[Twitter Status](https://twitter.com/rfc2616)or a similar descriptive text.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
106-106: Bare URL used
null(MD034, no-bare-urls)
101-102: Review Punctuation in Extended QuoteThe testimonial quote starting at line 101 contains an exclamation mark that might be perceived as excessive for its length. Please ensure that this punctuation aligns with the intended tone of the document.
🧰 Tools
🪛 LanguageTool
[style] ~102-~102: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1997 characters long)
Context: ...ls gems to manage front end dependencies! React on Rails provides webpack integra...(EN_EXCESSIVE_EXCLAMATION)
docs/javascript/webpack.md (1)
5-5: Minor Language Adjustment
Consider adding the article “an” before “example app” (i.e. “an example app”) to improve grammatical clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: You might be missing the article “an” here.
Context: ... "Code Splitting", etc You can try out example app, [shakacode/react-webpack-rails-tut...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/guides/webpack-configuration.md (1)
27-27: Grammar Improvement Suggestion
Consider inserting a comma before “and” to clearly separate the two independent clauses—for example:
“…very little code needed to get started, and you don't need to understand…”🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s very little code needed to get started and you don't need to understand really any...(COMMA_COMPOUND_SENTENCE)
docs/guides/how-to-use-different-files-for-client-and-server-rendering.md (1)
94-98: Robust Client-Side Check Recommendation
Usingif (window)works in many cases, but for a more robust environment check, consider usingif (typeof window !== 'undefined')to avoid potential runtime errors in non-browser environments.docs/javascript/react-router.md (1)
39-40: Compound Adjective Correction
Consider revising “server side bundle” to “server-side bundle” to adhere to correct compound adjective styling.🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...dering** and should be only used in the server side bundle. From the [original example in ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/react-helmet.md (4)
10-10: Conciseness Suggestion: Consider revising the sentence
“Here is what you need to do in order to configure your Rails application to work with ReactHelmet”
to something shorter such as: “Configure your Rails application for ReactHelmet as follows:”🧰 Tools
🪛 LanguageTool
[style] ~10-~10: Consider a shorter alternative to avoid wordiness.
Context: ...## Example Here is what you need to do in order to configure your Rails application to wor...(IN_ORDER_TO_PREMIUM)
78-78: Consistent Trailing Comma Usage: The addition of a trailing comma afterReactHelmetAppon line 78 in the client registration code promotes consistency and can help reduce diff noise in future changes.
87-87: Consistent Trailing Comma Usage: Similarly, the update on line 87 in the server registration snippet, by adding a trailing comma afterReactHelmetApp, maintains consistency across the examples.
92-93: Minor Grammar Improvement: In the sentence beginning at line 92, consider revising “returns a hash instead of HTML string” to “returns a hash instead of an HTML string” for improved grammatical accuracy.🧰 Tools
🪛 LanguageTool
[uncategorized] ~92-~92: You might be missing the article “an” here.
Context: ...gument it will return a hash instead of HTML string. Note, there is no need to speci...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[grammar] ~93-~93: Did you mean the proper noun or did you want to use it as a verb?
Context: ...rerender" as it would not make sense to use react_component_hash without server rendering...(HAVE_TWITTER)
docs/additional-details/generator-details.md (3)
41-44: Refine text for clarity and conciseness.The paragraph beginning at line 43 contains redundant punctuation and wordiness. For example, remove the comma after "functionality" and replace "inside of" with "in" for smoother reading. Also, rephrase the recommendation about larger projects to improve clarity.
-Each unique set of functionality, is given its own folder inside of `app/javascript/app/bundles`. Note, the recommended for bigger projects is `client/app/bundles`. This encourages for modularity of _domains_. +Each unique set of functionality is given its own folder in `app/javascript/app/bundles`. For larger projects, it is recommended to use `client/app/bundles`, which encourages modularity of _domains_.🧰 Tools
🪛 LanguageTool
[style] ~44-~44: This phrase is redundant. Consider using “inside”.
Context: ... functionality, is given its own folder inside ofapp/javascript/app/bundles. Note, the...(OUTSIDE_OF)
47-49: Enhance bullet list clarity and punctuation.The bullet points describing the folder structure can be streamlined for consistency. Consider revising the descriptions to remove unnecessary quotes and adjust punctuation for a clearer, more uniform presentation.
- - `startup`: This contains the entry point files for webpack. It defaults to a single file that is used for server and client compilation, but if these need to be different, then you can create two webpack configurations with separate endpoints. - - `containers`: "smart components" (components that have functionality and logic that is passed to child "dumb components"). - `components`: includes "dumb components", or components that simply render their properties and call functions given to them as properties by a parent component. Ultimately, at least one of these dumb components will have a parent container component. + - `startup`: Contains the entry point files for webpack. It defaults to a single file used for both server and client compilation; if different settings are required, you can create separate webpack configurations. + - `containers`: Represents smart components (components that manage logic and pass data to child dumb components). + - `components`: Includes dumb components that render properties and invoke functions provided by a parent component; typically, one such component is nested within a parent container.🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...find the following folders: -startup: This contains the entry point files for...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ... with separate endpoints. -containers: "smart components" (components that hav...(UNLIKELY_OPENING_PUNCTUATION)
54-58: Clarify and streamline the Redux section description.In the Redux section, the description repeats phrases unnecessarily. Consider rewording to directly state that using the
--reduxoption adds Redux-specific folders and updates the Hello World example to use Redux.-If you have used the `--redux` generator option, you will notice the familiar additional redux folders in addition to the aforementioned folders. The Hello World example has also been modified to use Redux. +If the `--redux` generator option is used, additional Redux-specific folders are included, and the Hello World example is updated to leverage Redux.🧰 Tools
🪛 LanguageTool
[uncategorized] ~58-~58: Did you mean “its” (the possessive pronoun)?
Context: ...e concept is that each bundle will have it's own Redux store. If you have code that ...(ITS_PREMIUM)
docs/guides/render-functions-and-railscontext.md (3)
24-31: Enhanced Functional Component Formatting
The arrow function definition forMyAppComponentis now split into multiple lines. This improves readability and aligns with current style guidelines. Please ensure that similar multi-line patterns are used consistently throughout the codebase.
141-149: Refined AppComponentWithRailsContext Example
The implementation forAppComponentWithRailsContexthas been reformatted to clearly show the higher-order component pattern. This improves readability and reinforces the intended use of wrapping a component to injectrailsContext.🧰 Tools
🪛 LanguageTool
[grammar] ~141-~141: “React” is a proper noun and needs to be capitalized.
Context: ...ops used for rendering. If you create a react component, rather than a render-functio...(A_GOOGLE)
42-42: Minor Grammar Suggestion
Consider adding the article “an” before “React.createElement” (e.g., “an alternate API…”) to improve grammatical correctness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: You might be missing the article “an” here.
Context: ...yAppComponent; ``` --- _This would be alternate API where you have to call React.create...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/additional-details/recommended-project-structure.md (6)
44-44: Detailed Environment Variable Instruction
The instruction to set theSHAKAPACKER_CONFIGenvironment variable is helpful and informative. For enhanced clarity, consider adding a brief example of how to set this variable in common environments (e.g., via a shell export or in a configuration file).
47-47: Clarify Styling Assets Decision
The sentence "Should you move your styling assets to Webpack? Or stick with the plain Rails asset pipeline. It depends!" could benefit from a slight rephrasing for improved grammatical flow. For example:
“Should you move your styling assets to Webpack or stick with the plain Rails asset pipeline? It depends on your project requirements.”
55-55: Wording Improvement
The sentence "This isn't really any technique, as you keep handling all your styling assets using Rails standard tools..." can be refined for clarity. Consider rephrasing it to:
“This approach isn’t really a new technique, as you continue managing your styling assets using Rails’ standard tools (e.g., via the [sass-rails gem]).”
59-59: Grammar Correction Needed
The phrase "There's no changes really from your current processes" is grammatically awkward. A suggested revision would be:
“There are no significant changes from your current processes.”
67-67: Asset Directory Description Refinement
The line "1./client/app/assets: Assets for CSS for client app." is concise; however, rephrasing slightly could improve clarity. Consider:
“CSS assets for the client app are located in/client/app/assets.”
72-72: Typographical Suggestion
The phrase "once you seen the benefits" contains a grammatical error. It should be corrected to "once you have seen the benefits" for clarity and correctness.docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (5)
9-10: Clarify the hot-reloading deprecation note.
The updated bullet clearly indicates that the legacy react‑hot‑loader has been deprecated in favor of fast‑refresh. Verify that the linked documentation (via the fast‑refresh URL) leads users to the current recommendations.
44-44: Adjust vertical spacing.
The change at line 44 (likely a newline adjustment) helps with spacing and overall document flow.
46-47: Enhance installation instruction clarity.
The reflowed sentence at line 46–47 (“To enable HMR functionality you have to use./bin/shakapacker-dev-server”) now reads more clearly. Consider a minor punctuation enhancement (e.g. a comma after “functionality”) to further improve readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...n ## Basic installation To enable HMR functionality you have to use `./bin/shakapacker-dev-...(AI_HYDRA_LEO_MISSING_COMMA)
83-85: Refine overlay.sockPort option explanation.
The description on line 85 clearly explains the purpose of settingoverlay.sockPortinReactRefreshWebpackPlugin. For greater clarity, consider a slight rewrite to improve grammar—for example:-We added `overlay.sockPort` option in `ReactRefreshWebpackPlugin` to match the webpack dev-server port specified in `config/shakapacker.yml`. That way we make sockjs works properly and suppress error in browser console `GET http://localhost:[port]/sockjs-node/info?t=[xxxxxxxxxx] 404 (Not Found)`. +We added the `overlay.sockPort` option in `ReactRefreshWebpackPlugin` to match the webpack dev-server port specified in `config/shakapacker.yml`. That way, we ensure sockjs works properly and suppress errors in the browser console (e.g. `GET http://localhost:[port]/sockjs-node/info?t=[xxxxxxxxxx] 404 (Not Found)`).This minor change improves grammatical correctness and clarity.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~85-~85: You might be missing the article “the” here.
Context: ... }) ) } ``` We addedoverlay.sockPortoption in `ReactRefres...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~85-~85: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...akapacker.yml`. That way we make sockjs works properly and suppress error in browser ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
98-98: Correct browser reflection phrasing.
The sentence “Now Browser should reflect .js along with .css changes without reloading.” could be improved for grammatical correctness. A suggested revision: “Now, the browser should reflect changes in both .js and .css files without reloading.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~98-~98: You might be missing the article “the” here.
Context: ...olean) } } ``` That's it :). Now Browser should reflect .js along with .css chan...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
CONTRIBUTING.md (1)
20-23: IDE Setup Instructions – Consider Adding a Comma
The IDE setup section is well formatted. For improved readability, consider inserting a comma after “Otherwise” in the sentence:-It's critical to configure your IDE/editor to ignore certain directories. Otherwise your IDE might slow to a crawl! +It's critical to configure your IDE/editor to ignore certain directories. Otherwise, your IDE might slow to a crawl!🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...E/editor to ignore certain directories. Otherwise your IDE might slow to a crawl! - /cov...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
spec/dummy/client/README.md (3)
9-10: Remove Trailing Punctuation from Heading
The heading “# Running linter:” contains a trailing colon. For consistency with markdown best practices, consider removing the punctuation. For example:-# Running linter: +# Running linter🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
9-9: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
21-23: Specify Language Identifier for Shell Command Blocks
The fenced code block showingyarn global add npm-check-updatesdoes not specify a language. For enhanced syntax highlighting and consistency, consider adding a language identifier (e.g.bash).-``` +y```bash🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
21-21: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
21-21: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
25-30: Enhance Shell Command Block Readability
The code block with the series of commands (changing to theclientdirectory, runningnpm-check-updates -u -a, and thenyarn) is clear. Similar to the previous comment, adding a language identifier (e.g.bash) may improve readability.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
25-25: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
25-25: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
docs/getting-started.md (3)
140-140: Heading Level Increment Issue
The heading "#### Different Server-Side Rendering Code (and a Server-Specific Bundle)" at line 140 jumps two levels (from an h2 or h3 to h4) without an intermediate heading level. Consider lowering it to an h3 for consistent structure.For example:
-#### Different Server-Side Rendering Code (and a Server-Specific Bundle) +### Different Server-Side Rendering Code (and a Server-Specific Bundle)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
140-140: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
144-144: Hyphenate Compound Adjective
In the phrase "different server side entry file," consider hyphenating "server side" to "server-side entry file" for better clarity and to address the static analysis hint.For example:
-...a different server side entry file, like 'serverRegistration.js' +...a different server-side entry file, like 'serverRegistration.js'🧰 Tools
🪛 LanguageTool
[uncategorized] ~144-~144: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...(EN_COMPOUND_ADJECTIVE_INTERNAL)
199-199: Verify File Extension Notation in I18n Section
The sentence "React on Rails provides an option for automatic conversions of Rails*.ymllocale files into*.jsonor_.js_." appears to have an inconsistent file-extension format (.js). Please confirm if this is a typographical error and, if needed, update it to a consistent format (for example,_.js`).docs/guides/client-vs-server-rendering.md (1)
25-25: Compound Adjective Hyphenation Suggestion
Consider hyphenating "server side" to "server-side" when it functions as a compound adjective modifying "entry file" for improved clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/outdated/rails-assets-relative-paths.md (4)
1-1: Formatting Note: Consider Updating Note Styling
The PR summary mentioned updating the opening note to bold italics for better emphasis. Currently, the note is written as Note: …, which renders as plain italics. Consider using a bold italic style (for example,***Note: …***) to meet the intended style.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1-1: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
51-51: Documentation Wording Enhancement
Consider revising the sentence "both of these two example above do the exact same thing, just using different syntaxes" to something like "Both examples above do the same thing, using different syntaxes." This change will improve grammatical correctness and conciseness.🧰 Tools
🪛 LanguageTool
[grammar] ~51-~51: After the number ‘two’, use a plural noun. Did you mean “examples”?
Context: ...name].[ext]', }, ``` both of these two example above do the exact same thing, just usi...(CD_NNU)
[style] ~51-~51: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ... both of these two example above do the exact same thing, just using different syntaxes. F...(EN_WORDINESS_PREMIUM_EXACT_SAME)
[uncategorized] ~51-~51: Possible missing comma found.
Context: ...ifferent syntaxes. For the rest of this doc we will be using the JSON object style....(AI_HYDRA_LEO_MISSING_COMMA)
61-61: Punctuation Suggestion
Adding a comma after the phrase "For now we're just going to use:" would improve the readability of this sentence.🧰 Tools
🪛 LanguageTool
[typographical] ~61-~61: Consider adding a comma here.
Context: ...r file's resulting name after bundling. For now we're just going to use: ```javascript...(FOR_NOW_COMMA)
67-67: Grammar and Punctuation Note
Ensure that abbreviations like "etc." are properly punctuated (i.e. "etc."). This aligns with American English style guidelines.🧰 Tools
🪛 LanguageTool
[style] ~67-~67: In American English, abbreviations like “etc.” require a period.
Context: ...nsion of the original file (.png, .jpg, etc). Next we'll set the outputPath for ou...(ETC_PERIOD)
docs/release-notes/15.0.0.md (2)
27-29: Detailed Configuration Defaults for HydrationThe new default settings for
defer_generated_component_packs(defaulting tofalse) andforce_load(defaulting totrue) are clearly communicated. In the second bullet (line 29), consider rephrasing for extra clarity. For example, you might use:
"- The previous need to defer scripts to prevent race conditions has been removed so that hydration starts promptly."
Also, review the hyphenation for any compound adjectives if needed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...l hydrate early without waiting for the full page load. This improves performance by elim...(EN_COMPOUND_ADJECTIVE_INTERNAL)
30-30: Fix Subject-Verb Agreement in Hydration DescriptionThe current phrasing "The
force_loadconfiguration makereact-on-railshydrate components immediately …" should be corrected to "makes" to ensure proper subject-verb agreement.docs/misc/doctrine.md (5)
25-27: Bullet List Formatting: Convention over ConfigurationThe bullet items are now consistently formatted. Please take a moment to review the flagged suggestions from static analysis—while phrases like “hard work” are standard, consider whether alternatives such as “altogether” might improve clarity.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: Write this as one word if you mean the noun “workout”.
Context: ...on - React on Rails has taken the hard work out of figuring out the JavaScript tooling ...(WORK_COMPOUNDS)
[grammar] ~27-~27: Using the adverb ‘altogether’ may be more appropriate in this context.
Context: ...u'd have to figure out how to splice it all together. This is where a lot of "JavaScript fat...(ALTOGETHER)
57-57: Stylistic Suggestion: Hyphenate “client-side”Consider modifying “client side development” to “client‐side development” for improved clarity and consistency across the document.
61-63: Consistency Improvement: Compound Adjective UsageTo align with conventional style guidelines, it would be preferable to hyphenate “client side code” as “client-side code.”
🧰 Tools
🪛 LanguageTool
[uncategorized] ~63-~63: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... ES6 is beautiful. React is beautiful. Client side code written with React plus Redux, ful...(EN_COMPOUND_ADJECTIVE_INTERNAL)
65-65: Stylistic Suggestion: Refine PhraseologyThe phrase “with lots of business rules” might be overly wordy; consider using “with numerous business rules.” Additionally, changing “client side app” to “client‐side app” may improve clarity.
67-69: Nitpick: Compound Adjective and Typo Corrections in Bullet List
- In the third bullet, “React driven pages” should be hyphenated to “React‐driven pages” for consistency.
- Additionally, please verify if “hundreds of standards Rails forms” is intended or if it should read “hundreds of standard Rails forms.”
🧰 Tools
🪛 LanguageTool
[style] ~67-~67: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...for Rails (document/database based with lots of business rules), the tight integration ...(A_LOT_OF)
[uncategorized] ~67-~67: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on Rails is better than building a pure client side app and separate microservices. Here's ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/file-system-based-automated-bundle-generation.md (4)
21-23: Clarify Components Subdirectory Description & Remove Extraneous Character
The revised text clearly explains thatcomponents_subdirectorydesignates directories for automatic component registration. However, there appears to be an extraneous symbol (·) at the end of the sentence on line 23; consider removing it for a cleaner presentation.
163-178: Add Language Specification to Directory Structure Code Block
The reformatted directory structure code block is much clearer. To fully comply with markdown best practices (MD040), consider specifying a language (for example, using```textor```plaintext) for the fenced code block.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
163-163: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
180-181: Punctuation Enhancement Suggestion
Consider inserting a comma after "For example" in the sentence "For example you can have a Rails view using three components:" to improve readability.🧰 Tools
🪛 LanguageTool
[typographical] ~180-~180: After the expression ‘for example’ a comma is usually used.
Context: ...ry` nor directly add their bundles. For example you can have a Rails view using three c...(COMMA_FOR_EXAMPLE)
207-207: Suggestion to Reduce Verbosity in Server Rendering Explanation
The explanation on line 207 regarding how server and client rendering components are handled could be made more concise. A shorter phrasing might help maintain focus without sacrificing clarity.🧰 Tools
🪛 LanguageTool
[style] ~207-~207: Consider a shorter alternative to avoid wordiness.
Context: ...ge both in server and client rendering. In order to have separate definitions for client an...(IN_ORDER_TO_PREMIUM)
NEWS.md (10)
5-7: Review Bullet Formatting for October 14, 2020 Entry.
The link text for the October 14, 2020 entry is split across two lines. Please double-check that the Markdown renderer correctly joins these lines so the link appears as intended.
8-10: Refine Verb Usage in SSR Bundle Description.
In the "August 2, 2020" entry, the phrase “a new way to setup the creation…” is used. Since “setup” is intended as a verb here, please change it to “set up” (e.g., “a new way to set up the creation…”).🧰 Tools
🪛 LanguageTool
[grammar] ~10-~10: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `r...(NOUN_VERB_CONFUSION)
12-13: Hyphenate Compound Adjective.
To improve clarity, consider changing “top level components” to “top-level components” in the first sub-bullet of the July 8, 2020 entry.🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v12**. 1. React Hooks Support for top level components 2. Typescript bindings...(EN_COMPOUND_ADJECTIVE_INTERNAL)
20-20: Clarify the Upgrade Instruction.
On line 20 the text “...update both the node module and the Ruby gem.” might read more clearly with an inserted determiner or clarifying noun (e.g., “update both the node module package and the Ruby gem”).🧰 Tools
🪛 LanguageTool
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ...rformance improvements! Please upgrade! Only "breaking" change is that you have to u...(AI_EN_LECTOR_MISSING_DETERMINER)
34-34: Duplicate Entry Detected.
There is an entry for the Documentation Gitbook on line 34 that duplicates the one on line 30. Removing one of these duplicates would help reduce redundancy in the changelog.
35-35: Duplicate v6.1 Entry.
The v6.1 entry appears both on line 31 and line 35. Please remove one instance to maintain a concise and non-redundant changelog.
48-48: Clarify Call-to-Action in Projects Page Entry.
The sentence “Please edit the page your project or [email us]…” is a bit unclear. Consider rephrasing to something like “Please edit the page to include your project, or email us and we’ll add it,” to improve clarity.
49-49: Strengthen Call-to-Action Language.
Instead of “let us know if you see any issues,” a phrase such as “please report any issues” could lend a more formal tone to this entry.🧰 Tools
🪛 LanguageTool
[style] ~49-~49: Consider an alternative verb to strengthen your wording.
Context: ...md) for details, and let us know if you see any issues! [Migration steps from 1.x](...(IF_YOU_HAVE_THIS_PROBLEM)
56-56: Fix Typo in Redux Error Message.
The bullet on line 56 contains the typo “lastest version” which should be corrected to “latest version.”
60-60: Refine Nomenclature and Punctuation.
When referring to the project name within descriptive text, consider capitalizing “react_on_rails” to “React on Rails” for consistency. Also, if multiple exclamation marks are used throughout the document, think about toning them down to maintain a professional tone.🧰 Tools
🪛 LanguageTool
[grammar] ~60-~60: “React” is a proper noun and needs to be capitalized.
Context: ...._ If you did generate a fresh app from react_on_rails and want to move to CSS Module...(A_GOOGLE)
[style] ~60-~60: Using many exclamation marks might seem excessive (in this case: 20 exclamation marks for a text that’s 8677 characters long)
Context: ...information. Ping us if you want to help! - ShakaCode...(EN_EXCESSIVE_EXCLAMATION)
docs/guides/upgrading-react-on-rails.md (5)
39-43: i18n Default Format Change Guidance
The update on i18n now informs users about switching the helper’s configuration. Consider double-checking the term “internalization” since the common term is “internationalization”. A short note on why JSON is more efficient could further benefit users.
215-216: Public Path Update for Loaders
The note regarding updating thepublicPathfor assets managed byurl-loaderandfile-loaderis useful. Including a short inline example might help further clarify the needed change.
254-266: Renaming Properties in WebpackConfigLoader
The detailed list of property renaming (e.g. fromwebpackOutputPathtooutput.path) is thorough. Consider formatting these changes in a table or list to enhance readability.
297-300: Renaming and Compile Settings for Webpacker Configuration
The instructions to renamewebpacker_lite.ymland adjust thecompilesetting are helpful. Watch out for any potential typos or repeated words (e.g. “webpacker webpacker setup”) and ensure clarity.🧰 Tools
🪛 LanguageTool
[duplication] ~300-~300: Possible typo: you repeated a word.
Context: ...packer.yml - If you are not using the webpacker webpacker setup, be sure to put in `compile: fals...(ENGLISH_WORD_REPEAT_RULE)
🪛 markdownlint-cli2 (0.17.2)
299-299: Bare URL used
null(MD034, no-bare-urls)
307-319: Development Server Configuration Details
The updated instructions for configuringdev_server(host, port, HMR, etc.) and for removing deprecated keys are comprehensive. Consider breaking this long list into a series of bullet points (or even a table) to improve readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~319-~319: You might be missing the article “the” here.
Context: ...dummy/config/webpacker.yml. - Remove keyshot_reloading_hostandhot_reloading...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
307-307: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
311-311: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
docs/rails/turbolinks.md (11)
10-12: Inline Code Formatting & Punctuation Suggestion
The inline code snippet (ReactOnRails.setOptions({ turbo: true })) is now rendered in code style. Consider adding a comma for clarity in the preceding sentence (e.g., “To configure Turbo, the following option can be set:”).🧰 Tools
🪛 LanguageTool
[typographical] ~11-~11: It seems that a comma is missing.
Context: ... obsolete. # Using Turbo To configure Turbo the following option can be set: `React...(IN_ORDER_TO_VB_COMMA)
20-24: Legacy Turbolinks Section – Content and Formatting
The “Legacy Turbolinks” section now clearly warns that the docs may be outdated and provides bullet guidance for Turbolinks inclusion. You might review the phrasing (e.g. “The below docs…” could be “The following docs…”) for conciseness.
27-29: Performance Note Clarity in HTML Loading Description
The explanation about loading only HTML (and not reloading JavaScript and stylesheets) is informative. However, consider reordering or rephrasing the sentence (e.g., “...even if the JavaScript and stylesheets are cached, they will still require parsing”) for improved clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~29-~29: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...reload JavaScript and stylesheets. This definitely can make an app perform better, even if the...(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
37-41: 'Why Not Turbolinks' Section – List Numbering
The bullet list under “## Why Not Turbolinks” appears uniformly numbered (each starting with “1.”). While this is acceptable in Markdown, consider using distinct numbers or a different bullet style if the order is important.
42-46: CSRF and Webpack Bundle Notes – Punctuation & Grammar
The “More Information” section is now more detailed. In the first bullet, several improvements are suggested:
- Insert “the” before “head element” (e.g., “changes the head element…”).
- Consider adding a comma before “however” to improve the natural pause.
- Revise “it need to work” to “it needs to work.”
A possible rewording could be:
“CSRF tokens need thorough checking with Turbolinks5. Turbolinks5 changes the head element via JavaScript (not only the body) on page changes with the correct CSRF meta tag. However, if the JS code parsed this from the head when several windows were opened, our specs did not all pass. I did not review the details—this may be related more to app code than the library. In any case, an additional check is advised because the CSRF helper in ReactOnRails needs to work with Turbolinks5.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...he head element by JavaScript (not only body) on page changes with the correct csrf ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...ag, but if the JS code parsed this from head when several windows were opened, then ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~44-~44: Consider inserting a comma before ‘however’.
Context: ...ecs were not all passing. I didn't look details however, may be it is app code related, not libr...(HOWEVER_MISSING_COMMA)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ... is app code related, not library code. Anyway it may need additional check because th...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~44-~44: You might be missing the article “a” here.
Context: ... need additional check because there is CSRF helper in ReactOnRails and it need to w...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Tur...(COMMA_COMPOUND_SENTENCE)
[grammar] ~44-~44: The pronoun ‘it’ requires a third-person verb or a past tense.
Context: ...e is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Turbolinks5...(HE_NEED)
80-88: Async Script Loading Explanation – Formatting and Punctuation
The “### async script loading” section now benefits from better line breaks and structure. A minor note: on line 81, a comma might improve the flow (e.g., “Generally, async script loading can be done like:”).🧰 Tools
🪛 LanguageTool
[uncategorized] ~81-~81: A comma might be missing here.
Context: ...start(); ``` ### async script loading Generally async script loading can be done like: ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
89-95: Deferred Script Loading Workaround and Reference Link
The explanation for usingdeferinstead ofasyncis clear. Note that the URL in line 94 is a bare URL; consider formatting it as a markdown link or enclosing it in angle brackets for improved style and to satisfy markdown linters.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
94-94: Bare URL used
null(MD034, no-bare-urls)
96-97: Sentence Punctuation in Component Registration Note
The sentence “When loading your scripts asynchronously you may experience, that your Components are not registered correctly…” contains an unnecessary comma. Removing it will improve readability to: “When loading your scripts asynchronously you may experience that your Components are not registered correctly…”🧰 Tools
🪛 LanguageTool
[uncategorized] ~96-~96: Possible missing comma found.
Context: ...ks/issues/28 When loading your scripts asynchronously you may experience, that your Component...(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~96-~96: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’.
Context: ...cripts asynchronously you may experience, that your Components are not registered corr...(COMMA_THAT_NOUN)
99-102: Code Block Language Specification
The fenced code block displaying the event listener forturbolinks:loaddoes not specify a language. Adding a language (e.g., ```javascript) will improve syntax highlighting and clarity.
136-141: Turbolinks Classic Message Block – Specify Language
The code block showing Turbolinks Classic log messages is informative. To improve clarity and satisfy markdown linters, consider specifying a language (e.g., using “```text”) for this fenced code block.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
138-138: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
143-148: Turbolinks 5 Message Block – Specify Language
Similarly, the code block for Turbolinks 5 log messages would benefit from an explicit language specifier for better syntax highlighting and consistency.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
145-145: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (2)
Gemfile.lockis excluded by!**/*.lockyarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (133)
.eslintrc(0 hunks).github/ISSUE_TEMPLATE/bug_report.md(0 hunks).github/ISSUE_TEMPLATE/feature_request.md(0 hunks).github/PULL_REQUEST_TEMPLATE.md(1 hunks).github/workflows/examples.yml(2 hunks).github/workflows/lint-js-and-ruby.yml(1 hunks).github/workflows/main.yml(2 hunks).github/workflows/package-js-tests.yml(1 hunks).github/workflows/rspec-package-specs.yml(1 hunks).prettierignore(1 hunks).prettierrc(1 hunks).scss-lint.yml(1 hunks)CHANGELOG.md(19 hunks)CONTRIBUTING.md(11 hunks)KUDOS.md(1 hunks)NEWS.md(1 hunks)PROJECTS.md(1 hunks)README.md(4 hunks)SUMMARY.md(1 hunks)docs/additional-details/generator-details.md(1 hunks)docs/additional-details/manual-installation-overview.md(1 hunks)docs/additional-details/migrating-from-react-rails.md(1 hunks)docs/additional-details/recommended-project-structure.md(2 hunks)docs/additional-details/tips-for-usage-with-sp6.md(1 hunks)docs/additional-details/updating-dependencies.md(2 hunks)docs/api/javascript-api.md(2 hunks)docs/api/redux-store-api.md(4 hunks)docs/api/view-helpers-api.md(8 hunks)docs/contributor-info/generator-testing.md(1 hunks)docs/contributor-info/linters.md(2 hunks)docs/contributor-info/pull-requests.md(2 hunks)docs/contributor-info/releasing.md(1 hunks)docs/deployment/elastic-beanstalk.md(1 hunks)docs/deployment/heroku-deployment.md(1 hunks)docs/getting-started.md(7 hunks)docs/guides/client-vs-server-rendering.md(2 hunks)docs/guides/configuration.md(4 hunks)docs/guides/file-system-based-automated-bundle-generation.md(5 hunks)docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md(2 hunks)docs/guides/how-react-on-rails-works.md(2 hunks)docs/guides/how-to-use-different-files-for-client-and-server-rendering.md(3 hunks)docs/guides/i18n.md(1 hunks)docs/guides/installation-into-an-existing-rails-app.md(2 hunks)docs/guides/minitest-configuration.md(1 hunks)docs/guides/rails-webpacker-react-integration-options.md(7 hunks)docs/guides/react-on-rails-overview.md(1 hunks)docs/guides/react-server-rendering.md(2 hunks)docs/guides/render-functions-and-railscontext.md(6 hunks)docs/guides/rspec-configuration.md(4 hunks)docs/guides/streaming-server-rendering.md(4 hunks)docs/guides/tutorial.md(12 hunks)docs/guides/upgrading-react-on-rails.md(13 hunks)docs/guides/webpack-configuration.md(2 hunks)docs/home.md(2 hunks)docs/javascript/angular-js-integration-migration.md(2 hunks)docs/javascript/capistrano-deployment.md(1 hunks)docs/javascript/code-splitting.md(5 hunks)docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md(1 hunks)docs/javascript/credits.md(0 hunks)docs/javascript/foreman-issues.md(1 hunks)docs/javascript/images.md(0 hunks)docs/javascript/node-dependencies-and-npm.md(1 hunks)docs/javascript/react-and-redux.md(1 hunks)docs/javascript/react-helmet.md(6 hunks)docs/javascript/react-router.md(3 hunks)docs/javascript/server-rendering-tips.md(2 hunks)docs/javascript/troubleshooting-when-using-shakapacker.md(1 hunks)docs/javascript/troubleshooting-when-using-webpacker.md(1 hunks)docs/javascript/webpack-v1-notes.md(1 hunks)docs/javascript/webpack.md(2 hunks)docs/misc/articles.md(1 hunks)docs/misc/doctrine.md(2 hunks)docs/misc/style.md(1 hunks)docs/misc/tips.md(1 hunks)docs/outdated/deferred-rendering.md(2 hunks)docs/outdated/rails-assets-relative-paths.md(8 hunks)docs/outdated/rails-assets.md(2 hunks)docs/outdated/rails3.md(1 hunks)docs/rails/rails-engine-integration.md(2 hunks)docs/rails/rails_view_rendering_from_inline_javascript.md(2 hunks)docs/rails/turbolinks.md(3 hunks)docs/release-notes/15.0.0.md(3 hunks)docs/testimonials/resortpass.md(1 hunks)docs/testimonials/testimonials.md(1 hunks)knip.ts(1 hunks)lib/generators/react_on_rails/templates/.eslintrc(1 hunks)lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.module.css(1 hunks)lib/generators/react_on_rails/templates/base/base/config/shakapacker.yml(1 hunks)node_package/src/Authenticity.ts(1 hunks)node_package/src/CallbackRegistry.ts(4 hunks)node_package/src/ClientSideRenderer.ts(10 hunks)node_package/src/ComponentRegistry.ts(2 hunks)node_package/src/RSCClientRoot.ts(5 hunks)node_package/src/ReactOnRails.client.ts(7 hunks)node_package/src/ReactOnRails.full.ts(2 hunks)node_package/src/ReactOnRailsRSC.ts(2 hunks)node_package/src/StoreRegistry.ts(2 hunks)node_package/src/buildConsoleReplay.ts(2 hunks)node_package/src/clientStartup.ts(1 hunks)node_package/src/context.ts(1 hunks)node_package/src/createReactOutput.ts(3 hunks)node_package/src/handleError.ts(2 hunks)node_package/src/isRenderFunction.ts(1 hunks)node_package/src/isServerRenderResult.ts(1 hunks)node_package/src/pageLifecycle.ts(1 hunks)node_package/src/reactApis.ts(1 hunks)node_package/src/reactHydrateOrRender.ts(1 hunks)node_package/src/registerServerComponent/client.ts(2 hunks)node_package/src/registerServerComponent/server.ts(1 hunks)node_package/src/serverRenderReactComponent.ts(8 hunks)node_package/src/serverRenderUtils.ts(2 hunks)node_package/src/streamServerRenderedReactComponent.ts(8 hunks)node_package/src/transformRSCStreamAndReplayConsoleLogs.ts(3 hunks)node_package/src/turbolinksUtils.ts(2 hunks)node_package/src/types/index.ts(6 hunks)node_package/src/utils.ts(1 hunks)package-scripts.yml(2 hunks)package.json(1 hunks)rakelib/examples_config.yml(1 hunks)spec/dummy/.prettierignore(0 hunks)spec/dummy/.prettierrc(0 hunks)spec/dummy/README.md(2 hunks)spec/dummy/app/assets/stylesheets/application_non_webpack.scss(1 hunks)spec/dummy/client/.jscsrc(0 hunks)spec/dummy/client/README.md(3 hunks)spec/dummy/client/app/components/CssModulesImagesFontsExample.module.scss(2 hunks)spec/dummy/client/app/components/ImageExample/ImageExample.module.scss(1 hunks)spec/dummy/client/app/startup/RouterApp.server.jsx(1 hunks)spec/dummy/config/locales/en.yml(1 hunks)spec/dummy/config/shakapacker.yml(1 hunks)spec/dummy/config/storage.yml(0 hunks)spec/react_on_rails/fixtures/i18n/locales/de.yml(1 hunks)spec/react_on_rails/fixtures/i18n/locales/en.yml(1 hunks)
💤 Files with no reviewable changes (9)
- .github/ISSUE_TEMPLATE/bug_report.md
- docs/javascript/credits.md
- docs/javascript/images.md
- .eslintrc
- spec/dummy/config/storage.yml
- spec/dummy/.prettierignore
- .github/ISSUE_TEMPLATE/feature_request.md
- spec/dummy/.prettierrc
- spec/dummy/client/.jscsrc
🚧 Files skipped from review as they are similar to previous changes (78)
- spec/react_on_rails/fixtures/i18n/locales/de.yml
- docs/guides/react-on-rails-overview.md
- docs/additional-details/updating-dependencies.md
- docs/additional-details/tips-for-usage-with-sp6.md
- lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.module.css
- docs/guides/rspec-configuration.md
- node_package/src/utils.ts
- .github/PULL_REQUEST_TEMPLATE.md
- docs/javascript/troubleshooting-when-using-webpacker.md
- spec/react_on_rails/fixtures/i18n/locales/en.yml
- node_package/src/reactApis.ts
- SUMMARY.md
- spec/dummy/client/app/components/ImageExample/ImageExample.module.scss
- docs/deployment/heroku-deployment.md
- spec/dummy/config/locales/en.yml
- node_package/src/context.ts
- docs/guides/minitest-configuration.md
- node_package/src/pageLifecycle.ts
- docs/outdated/deferred-rendering.md
- node_package/src/clientStartup.ts
- .github/workflows/lint-js-and-ruby.yml
- docs/misc/articles.md
- docs/additional-details/migrating-from-react-rails.md
- docs/javascript/react-and-redux.md
- spec/dummy/app/assets/stylesheets/application_non_webpack.scss
- .github/workflows/rspec-package-specs.yml
- node_package/src/ComponentRegistry.ts
- docs/javascript/node-dependencies-and-npm.md
- knip.ts
- node_package/src/serverRenderReactComponent.ts
- node_package/src/Authenticity.ts
- docs/contributor-info/releasing.md
- lib/generators/react_on_rails/templates/base/base/config/shakapacker.yml
- node_package/src/CallbackRegistry.ts
- docs/guides/react-server-rendering.md
- docs/guides/installation-into-an-existing-rails-app.md
- node_package/src/ReactOnRails.full.ts
- node_package/src/turbolinksUtils.ts
- .scss-lint.yml
- package.json
- node_package/src/isRenderFunction.ts
- .prettierignore
- lib/generators/react_on_rails/templates/.eslintrc
- .github/workflows/examples.yml
- docs/guides/configuration.md
- node_package/src/streamServerRenderedReactComponent.ts
- .github/workflows/main.yml
- node_package/src/registerServerComponent/client.ts
- node_package/src/handleError.ts
- node_package/src/RSCClientRoot.ts
- .prettierrc
- node_package/src/ReactOnRailsRSC.ts
- spec/dummy/config/shakapacker.yml
- docs/javascript/code-splitting.md
- node_package/src/createReactOutput.ts
- docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md
- docs/testimonials/testimonials.md
- docs/guides/streaming-server-rendering.md
- rakelib/examples_config.yml
- package-scripts.yml
- node_package/src/registerServerComponent/server.ts
- node_package/src/serverRenderUtils.ts
- node_package/src/transformRSCStreamAndReplayConsoleLogs.ts
- docs/rails/rails_view_rendering_from_inline_javascript.md
- node_package/src/ClientSideRenderer.ts
- CHANGELOG.md
- node_package/src/StoreRegistry.ts
- docs/javascript/foreman-issues.md
- .github/workflows/package-js-tests.yml
- node_package/src/ReactOnRails.client.ts
- docs/javascript/troubleshooting-when-using-shakapacker.md
- spec/dummy/client/app/components/CssModulesImagesFontsExample.module.scss
- docs/api/javascript-api.md
- docs/api/redux-store-api.md
- spec/dummy/client/app/startup/RouterApp.server.jsx
- node_package/src/buildConsoleReplay.ts
- node_package/src/types/index.ts
- node_package/src/isServerRenderResult.ts
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
7-7: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
KUDOS.md
70-70: Bare URL used
null
(MD034, no-bare-urls)
106-106: Bare URL used
null
(MD034, no-bare-urls)
PROJECTS.md
52-52: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
docs/additional-details/recommended-project-structure.md
32-32: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
38-38: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/getting-started.md
140-140: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
docs/guides/file-system-based-automated-bundle-generation.md
163-163: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/guides/how-react-on-rails-works.md
5-5: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
5-5: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
docs/guides/upgrading-react-on-rails.md
64-64: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
143-143: Bare URL used
null
(MD034, no-bare-urls)
182-182: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
299-299: Bare URL used
null
(MD034, no-bare-urls)
303-303: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/javascript/capistrano-deployment.md
16-16: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
docs/outdated/rails-assets-relative-paths.md
1-1: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
docs/outdated/rails-assets.md
3-3: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
docs/rails/turbolinks.md
94-94: Bare URL used
null
(MD034, no-bare-urls)
98-98: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
138-138: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
spec/dummy/client/README.md
9-9: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
21-21: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
21-21: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
25-25: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
25-25: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~22-~22: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...E/editor to ignore certain directories. Otherwise your IDE might slow to a crawl! - /cov...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~81-~81: Consider shortening or rephrasing this to strengthen your wording.
Context: ...eact-on-rails ``` The workflow is: 1. Make changes to the node package. 2. We need yalc to pu...
(MAKE_CHANGES)
[style] ~185-~185: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...figs, then you need to restart foreman. If you change the JS code for react-on-rai...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~205-~205: A comma might be missing here.
Context: .... ### Install Generator In your Rails app add this gem with a path to your fork. ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~237-~237: The word ‘lint’ is a noun or an adjective. A verb or adverb is missing or misspelled here, or maybe a comma is missing.
Context: ...changes via the lint container. You can lint locally by running `npm run lint && npm...
(PRP_MD_NN)
[grammar] ~242-~242: The word ‘install’ is not a noun.
Context: ...he initial build is slow, but after the install, startup is very quick. ### Linting Co...
(A_INSTALL)
[style] ~242-~242: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...slow, but after the install, startup is very quick. ### Linting Commands Run rake lint...
(EN_WEAK_ADJECTIVE)
KUDOS.md
[style] ~49-~49: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ators are great and the community is so awesome and welcoming. In fact, I love it so mu...
(AWESOME)
[grammar] ~49-~49: “React” is a proper noun and needs to be capitalized.
Context: ...Rails](https://goo.gl/uzu36X) using the react_on_rails gem!" ![The Complete React on ...
(A_GOOGLE)
[style] ~102-~102: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1997 characters long)
Context: ...ls gems to manage front end dependencies! React on Rails provides webpack integra...
(EN_EXCESSIVE_EXCLAMATION)
NEWS.md
[grammar] ~10-~10: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `r...
(NOUN_VERB_CONFUSION)
[uncategorized] ~12-~12: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v12**. 1. React Hooks Support for top level components 2. Typescript bindings...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ...rformance improvements! Please upgrade! Only "breaking" change is that you have to u...
(AI_EN_LECTOR_MISSING_DETERMINER)
[inconsistency] ~29-~29: Did you mean to refer to the current year? November 10, 2025 is not a Thursday, but a Monday.
Context: ...) - 2016-11-03: Spoke at [LA Ruby, 7pm, Thursday, November 10 in Venice, CA: "React on Rails: Why, Wh...
(EN_DATE_WEEKDAY_CURRENTYEAR)
[style] ~49-~49: Consider an alternative verb to strengthen your wording.
Context: ...md) for details, and let us know if you see any issues! [Migration steps from 1.x](...
(IF_YOU_HAVE_THIS_PROBLEM)
[grammar] ~60-~60: “React” is a proper noun and needs to be capitalized.
Context: ...._ If you did generate a fresh app from react_on_rails and want to move to CSS Module...
(A_GOOGLE)
[style] ~60-~60: Using many exclamation marks might seem excessive (in this case: 20 exclamation marks for a text that’s 8677 characters long)
Context: ...information. Ping us if you want to help! - ShakaCode...
(EN_EXCESSIVE_EXCLAMATION)
PROJECTS.md
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...You can confirm a project uses React on Rails as the source will contain **`js-react-...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...eals](https://www.redflagdeals.com/)**, Canadian shopping site. - **[YourMechanic](https...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~22-~22: You might be missing the article “a” here.
Context: ...](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. - **[HVMN...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~29-~29: This word is normally spelled as one.
Context: ...has gone live with React on Rails, with multi-lingual JavaScript support! ![2016-05-03_19-1...
(EN_COMPOUNDS_MULTI_LINGUAL)
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...lational Marketing for Real Estate. ## Open Source Projects Live - [github.com/empirical-...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ps://github.com/sharetribe/sharetribe): Open source marketplace platform.
(EN_COMPOUND_ADJECTIVE_INTERNAL)
README.md
[style] ~87-~87: Style-wise, it’s not ideal to insert an adverb (‘conditionally’) in the middle of an infinitive construction (‘to render’). Try moving the adverb to avoid split infinitives.
Context: ...lient-and-server-rendering/1352) - [How to conditionally render server side based on the device type](https://forum...
(SPLIT_INFINITIVE)
docs/additional-details/generator-details.md
[style] ~44-~44: This phrase is redundant. Consider using “inside”.
Context: ... functionality, is given its own folder inside of app/javascript/app/bundles. Note, the...
(OUTSIDE_OF)
[style] ~45-~45: This phrase is redundant. Consider using “Inside”.
Context: ...ncourages for modularity of domains. Inside of the generated "HelloWorld" domain you w...
(OUTSIDE_OF)
[uncategorized] ~46-~46: Possible missing comma found.
Context: .... Inside of the generated "HelloWorld" domain you will find the following folders: -...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...find the following folders: - startup: This contains the entry point files for...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ... with separate endpoints. - containers: "smart components" (components that hav...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...child "dumb components"). - components: includes "dumb components", or componen...
(UNLIKELY_OPENING_PUNCTUATION)
docs/additional-details/manual-installation-overview.md
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...eet_pack_tagandjavascript_pack_tag` helpers which is used to load the bundled asset...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...and javascript_pack_tag helpers which is used to load the bundled assets to your...
(AI_HYDRA_LEO_CPT_IS_ARE)
docs/additional-details/recommended-project-structure.md
[style] ~50-~50: Consider an alternative adjective to strengthen your wording.
Context: ...s asset pipeline. It depends! Here's a good discussion of this option: [Why does Ra...
(GOOD_CONSTRUCTIVE)
[grammar] ~60-~60: Did you mean “There are no changes”?
Context: ... the Simple Rails Way 1. Much simpler! There's no changes really from your current processes. ##...
(THERE_S_MANY)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ctory structure 1. /client/app/assets: Assets for CSS for client app. 1. `/cli...
(UNLIKELY_OPENING_PUNCTUATION)
docs/api/view-helpers-api.md
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... you want to see the server side or the client side rails_context. Typically, for computing...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/contributor-info/generator-testing.md
[style] ~3-~3: This phrase is redundant. Consider writing “various” or “different”.
Context: ...act_on_rails/install_generator.rb) with various different options. We can then run tests with the...
(VARIOUS_DIFFERENT)
[uncategorized] ~9-~9: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... add that dependency to the main Gemfile or it will not work in CI. ## Configuring...
(COMMA_COMPOUND_SENTENCE)
docs/contributor-info/linters.md
[style] ~16-~16: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...` 3. eslint:: Be sure to be in the right directory where you have JS files. ```...
(REP_RIGHT)
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ... Useful Reference Links - Configuring ESLint - [ESLint quick start](http://untilfalse.com/esli...
(ENGLISH_WORD_REPEAT_RULE)
docs/contributor-info/pull-requests.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...# Checklist before Committing 1. rake: runs all linters and specs (you need Do...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Possible missing article found.
Context: ...d entry? For non-doc fixes: - Provide changelog entry in the [unreleased section of the...
(AI_HYDRA_LEO_MISSING_A)
docs/deployment/elastic-beanstalk.md
[grammar] ~47-~47: “React” is a proper noun and needs to be capitalized.
Context: ...ic beanstalk successfully. However, the react app javascript files are under `public/...
(A_GOOGLE)
docs/getting-started.md
[uncategorized] ~144-~144: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/client-vs-server-rendering.md
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/file-system-based-automated-bundle-generation.md
[typographical] ~180-~180: After the expression ‘for example’ a comma is usually used.
Context: ...ry` nor directly add their bundles. For example you can have a Rails view using three c...
(COMMA_FOR_EXAMPLE)
[style] ~207-~207: Consider a shorter alternative to avoid wordiness.
Context: ...ge both in server and client rendering. In order to have separate definitions for client an...
(IN_ORDER_TO_PREMIUM)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...efresh). For use with webpack, see **Client Side rendering and HMR using react-refresh-w...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~17-~17: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...cker-dev-server` during development. # Server Side Rendering with the Default shakacode/sh...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~19-~19: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ... server-side rendering, then you have a couple options. The recommended technique is to have a...
(PLENTY_OF_NOUNS)
[uncategorized] ~43-~43: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...' of undefined" (if inline is true)` # Client Side rendering with HMR using react-refresh-...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...n ## Basic installation To enable HMR functionality you have to use `./bin/shakapacker-dev-...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~85-~85: You might be missing the article “the” here.
Context: ... }) ) } ``` We added overlay.sockPort option in `ReactRefres...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~85-~85: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...akapacker.yml`. That way we make sockjs works properly and suppress error in browser ...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~98-~98: You might be missing the article “the” here.
Context: ...olean) } } ``` That's it :). Now Browser should reflect .js along with .css chan...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~100-~100: A comma might be missing here.
Context: ...ding. If by some reason plugin doesn't work you could revert changes and left only ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~100-~100: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ... devServer hmr/inline to true affecting only css files. These plugins are working a...
(ADVERB_REPETITION_PREMIUM)
docs/guides/how-to-use-different-files-for-client-and-server-rendering.md
[uncategorized] ~7-~7: Possible missing comma found.
Context: .... This only works for a top-level entry point such as the entry point for a react-rou...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/i18n.md
[grammar] ~29-~29: Normally, after “try to” a verb is expected.
Context: ...k process as well. Note: if you try to lint before running tests, and you depend on...
(WANT_TO_NN)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...he translations before running the lint command or 2. to run the tests first. 4. If...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/rails-webpacker-react-integration-options.md
[uncategorized] ~157-~157: You might be missing the article “the” here.
Context: ...plugin react-hot-loader/babel with option "safetyNet": false: ``` { "plugi...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/guides/render-functions-and-railscontext.md
[uncategorized] ~42-~42: You might be missing the article “an” here.
Context: ...yAppComponent; ``` --- _This would be alternate API where you have to call React.create...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/guides/tutorial.md
[uncategorized] ~75-~75: You might be missing the article “the” here.
Context: ...t-react-on-rails ``` Note: You can use --database=postgresql option to use Pos...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~368-~368: A comma might be missing here.
Context: ...ample, to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/guides/upgrading-react-on-rails.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nfiguration to a better setup ready for Server Side Rendering. ## Upgrading to v13 ### Br...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~56-~56: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ction that takes only zero or one params and you return a React Element**, often JSX...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ction that takes only zero or one params and you return an Object (_not a React Elem...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ion will be treated as a render function and it can return an Object rather than a R...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~133-~133: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...(https://github.com/rails/webpacker) to setup your Webpack configuration. ```yml def...
(NOUN_VERB_CONFUSION)
[uncategorized] ~144-~144: The preposition “by” seems more likely in this position.
Context: ..._RAILS"] usage. You can get all tracing with either specifying trace at your c...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~165-~165: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ndles to bypass the Rails asset pipeline and it's extra minification, enabling you t...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ... your client directory - .gitignore: add /public/webpack/* - Gemfile: bu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ... config/initializers/react_on_rails.rb: - Delete `config.generated_assets_dir...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~178-~178: The verb ‘Replace’ is plural. Did you mean: “replaces”? Did you use a verb instead of a noun?
Context: ...onfig now supplies this information - Replace `config.npm_build_(test|production)_com...
(PLURAL_VERB_AFTER_THIS)
[uncategorized] ~179-~179: A comma might be missing here.
Context: ...commend setting dev_server.hmr to false however since HMR is currently broken. - `clien...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~180-~180: Loose punctuation mark.
Context: ...urrently broken. - client/package.json: bump react_on_rails (I recommend bump...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~225-~225: This phrase is duplicated. You should probably use “Run Run” only once.
Context: ...rade RoR in the client/package.json - Run bundle - Run rails webpacker:install - Run rails webpacker:install:react - Run rails g react_on_rails:install - Move...
(PHRASE_REPETITION)
[style] ~242-~242: This phrase is redundant. Consider using “inside”.
Context: ...toconfig/initializers/react_on_rails.rbto keep your node_modules inside of/client 2. Renamed - config.npm_b...
(OUTSIDE_OF)
[formatting] ~269-~269: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...name,** unless the bundle is server side.: ``` const webpackConfigLoader ...
(DOUBLE_PUNCTUATION_PREMIUM)
[duplication] ~300-~300: Possible typo: you repeated a word.
Context: ...packer.yml - If you are not using the webpacker webpacker setup, be sure to put in `compile: fals...
(ENGLISH_WORD_REPEAT_RULE)
docs/guides/webpack-configuration.md
[uncategorized] ~27-~27: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s very little code needed to get started and you don't need to understand really any...
(COMMA_COMPOUND_SENTENCE)
docs/home.md
[grammar] ~22-~22: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `s...
(NOUN_VERB_CONFUSION)
docs/javascript/angular-js-integration-migration.md
[grammar] ~7-~7: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ave not already done this, then you can setup the ReactOnRails default JS code dire...
(NOUN_VERB_CONFUSION)
[style] ~7-~7: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style.
Context: ...inclusion this way will be no different than using the Rails asset pipeline. However...
(DIFFERENT_THAN)
docs/javascript/capistrano-deployment.md
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: ...t Make sure ReactOnRails is working in development environment. Add the following to deve...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/javascript/react-helmet.md
[style] ~10-~10: Consider a shorter alternative to avoid wordiness.
Context: ...## Example Here is what you need to do in order to configure your Rails application to wor...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~36-~36: Possible missing comma found.
Context: .....props} />; ``` Or a render-function. Note you can't return just the JSX (React el...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~92-~92: You might be missing the article “an” here.
Context: ...gument it will return a hash instead of HTML string. Note, there is no need to speci...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[grammar] ~93-~93: Did you mean the proper noun or did you want to use it as a verb?
Context: ...rerender" as it would not make sense to use react_component_hash without server rendering...
(HAVE_TWITTER)
docs/javascript/react-router.md
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...dering** and should be only used in the server side bundle. From the [original example in ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/server-rendering-tips.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Your code can't reference document. Server side JS execution does not have access to `d...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...d call setTimout. Here's an example of this which shows the line numbers that end u...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/javascript/webpack-v1-notes.md
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1166 characters long)
Context: ...ment halt if Webpack cannot complete! For more details, see the documentation...
(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~7-~7: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Webpack returning a non-zero error code and you want to see all the errors, rather ...
(COMMA_COMPOUND_SENTENCE)
docs/javascript/webpack.md
[uncategorized] ~5-~5: You might be missing the article “an” here.
Context: ... "Code Splitting", etc You can try out example app, [shakacode/react-webpack-rails-tut...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/misc/doctrine.md
[uncategorized] ~27-~27: Write this as one word if you mean the noun “workout”.
Context: ...on - React on Rails has taken the hard work out of figuring out the JavaScript tooling ...
(WORK_COMPOUNDS)
[grammar] ~27-~27: Using the adverb ‘altogether’ may be more appropriate in this context.
Context: ...u'd have to figure out how to splice it all together. This is where a lot of "JavaScript fat...
(ALTOGETHER)
[uncategorized] ~59-~59: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... from the perspective that it rocks for client side development with Rails, even though it'...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~63-~63: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... ES6 is beautiful. React is beautiful. Client side code written with React plus Redux, ful...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~67-~67: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...for Rails (document/database based with lots of business rules), the tight integration ...
(A_LOT_OF)
[uncategorized] ~67-~67: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on Rails is better than building a pure client side app and separate microservices. Here's ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~71-~71: The adjective “React-driven” is spelled with a hyphen.
Context: ...ws mixing and matching Rails pages with React driven pages, even on the same page. Not every...
(DRIVEN_HYPHEN)
[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p with: - Community suggestions. - New client side tooling, libraries, and techniques. - U...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/misc/style.md
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...n. - Anything additional goes next. ## Client Side JavaScript and React - See the [Shakac...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~39-~39: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...ow a github-flow model where you branch off of master for features. - Before merging a...
(EN_WORDINESS_PREMIUM_OFF_OF)
docs/misc/tips.md
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ht now is prerender: false. NOTE: Server side rendering does not work for some compon...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~11-~11: “React” is a proper noun and needs to be capitalized.
Context: ...nt. - Be sure you can first render your react component client only before you tr...
(A_GOOGLE)
docs/outdated/rails-assets-relative-paths.md
[grammar] ~51-~51: After the number ‘two’, use a plural noun. Did you mean “examples”?
Context: ...name].[ext]', }, ``` both of these two example above do the exact same thing, just usi...
(CD_NNU)
[style] ~51-~51: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ... both of these two example above do the exact same thing, just using different syntaxes. F...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
[uncategorized] ~51-~51: Possible missing comma found.
Context: ...ifferent syntaxes. For the rest of this doc we will be using the JSON object style....
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...k.github.io/docs/using-loaders.html). _For the sake of this doc, we're also going ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[typographical] ~61-~61: Consider adding a comma here.
Context: ...r file's resulting name after bundling. For now we're just going to use: ```javascript...
(FOR_NOW_COMMA)
[style] ~67-~67: In American English, abbreviations like “etc.” require a period.
Context: ...nsion of the original file (.png, .jpg, etc). Next we'll set the outputPath for ou...
(ETC_PERIOD)
docs/outdated/rails-assets.md
[uncategorized] ~8-~8: Did you mean: “By default,”?
Context: ...e other term for this is a "digest". > By default the filename of the resulting file is t...
(BY_DEFAULT_COMMA)
docs/outdated/rails3.md
[style] ~3-~3: Consider using a different verb to strengthen your wording.
Context: # Rails 3 - Please let us know if you find any issues with Rails 3. - Rails 3 is c...
(FIND_ENCOUNTER)
[style] ~5-~5: Consider using a different verb to strengthen your wording.
Context: ...not testing it for new releases. If you find an issue, you will have to submit a PR ...
(FIND_ENCOUNTER)
docs/rails/rails-engine-integration.md
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...ture: target destination option for the install generator #459](https://github.com/shak...
(A_INSTALL)
docs/rails/turbolinks.md
[typographical] ~11-~11: It seems that a comma is missing.
Context: ... obsolete. # Using Turbo To configure Turbo the following option can be set: `React...
(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~29-~29: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...reload JavaScript and stylesheets. This definitely can make an app perform better, even if the...
(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...he head element by JavaScript (not only body) on page changes with the correct csrf ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...ag, but if the JS code parsed this from head when several windows were opened, then ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~44-~44: Consider inserting a comma before ‘however’.
Context: ...ecs were not all passing. I didn't look details however, may be it is app code related, not libr...
(HOWEVER_MISSING_COMMA)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ... is app code related, not library code. Anyway it may need additional check because th...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~44-~44: You might be missing the article “a” here.
Context: ... need additional check because there is CSRF helper in ReactOnRails and it need to w...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Tur...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~44-~44: The pronoun ‘it’ requires a third-person verb or a past tense.
Context: ...e is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Turbolinks5...
(HE_NEED)
[uncategorized] ~81-~81: A comma might be missing here.
Context: ...start(); ``` ### async script loading Generally async script loading can be done like: ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~96-~96: Possible missing comma found.
Context: ...ks/issues/28 When loading your scripts asynchronously you may experience, that your Component...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~96-~96: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’.
Context: ...cripts asynchronously you may experience, that your Components are not registered corr...
(COMMA_THAT_NOUN)
docs/release-notes/15.0.0.md
[uncategorized] ~28-~28: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...l hydrate early without waiting for the full page load. This improves performance by elim...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ded. - The force_load configuration make react-on-rails hydrate components imm...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...hes the client, without waiting for the full page load. - If you want to keep the previ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...zers/react_on_rails.rbfile. - If we want to keep the original behavior offorce_lo...
(REP_WANT_TO_VB)
[uncategorized] ~34-~34: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ce_loadconfiguration. - Redux store supportforce_loadoption now and it usesco...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~34-~34: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ux store support force_load option now and it uses config.force_load value as th...
(COMMA_COMPOUND_SENTENCE)
docs/testimonials/resortpass.md
[style] ~3-~3: Consider an alternative adjective to strengthen your wording.
Context: ...ted code that both works and reflects a deep understanding of the technologies and p...
(DEEP_PROFOUND)
[grammar] ~3-~3: “React” is a proper noun and needs to be capitalized.
Context: ...s and standards for our transition to a react on rails application. Just three months...
(A_GOOGLE)
spec/dummy/README.md
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e spec/dummy/client/node_modules to the top level - Be sure to install yarn dependencies ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 Biome (1.9.4)
node_package/src/reactHydrateOrRender.ts
[error] 38-38: Do not depend on the value returned by the function ReactDOM.render().
The returned value is legacy and future versions of React might return that value asynchronously.
Check the React documentation for more information.
(lint/correctness/noRenderReturnValue)
🔇 Additional comments (196)
docs/deployment/elastic-beanstalk.md (1)
45-45: Formatting Consistency Check for Deployment InstructionsThe revised text maintains clarity by explaining that the script installs Yarn and Node.js dependencies before asset precompilation, and creates a required directory. The formatting changes do not alter the intended meaning.
node_package/src/reactHydrateOrRender.ts (3)
41-45: Function signature formatting improves readability.The multi-line function signature increases code readability while maintaining functionality.
37-38: Consider refactoring the legacy render return value usage.While the code includes an ESLint disable comment, the usage of
ReactDOM.render's return value is discouraged as it's a legacy pattern. Future versions of React might return this value asynchronously.🧰 Tools
🪛 Biome (1.9.4)
[error] 38-38: Do not depend on the value returned by the function ReactDOM.render().
The returned value is legacy and future versions of React might return that value asynchronously.
Check the React documentation for more information.(lint/correctness/noRenderReturnValue)
1-47: Overall formatting looks good.The formatting changes throughout the file are consistent with Prettier standards and improve readability without altering functionality.
🧰 Tools
🪛 Biome (1.9.4)
[error] 38-38: Do not depend on the value returned by the function ReactDOM.render().
The returned value is legacy and future versions of React might return that value asynchronously.
Check the React documentation for more information.(lint/correctness/noRenderReturnValue)
docs/javascript/webpack-v1-notes.md (1)
10-10: Formatting Enhancement: Improved Section SeparationThe addition of a blank line before the "Entry Points" section effectively improves readability by creating a clear visual separation between content blocks. Great improvement!
docs/misc/tips.md (1)
3-8: Clarify and Enhance Build Instructions.
The newly added instructions for usingforeman start -f Procfile.devinstead ofrails sare clear and helpful. For additional context, consider briefly explaining whyrails sshould be avoided (for example, issues with bundle rebuilding that may lead to test discrepancies).docs/guides/i18n.md (8)
7-10: Code Block forconfig.i18n_dirConfiguration is Well-Formatted
The Ruby code block now clearly presents the configuration for setting the directory of translation files. The improved formatting aids readability and maintains consistency with the rest of the document.
12-18: Enhanced Formatting forconfig.i18n_yml_dirSetup
The adjustments in this code block improve clarity regarding setting the YAML directory. Make sure that the placeholder paths (e.g.,"PATH_TO", "YOUR_YAML_I18N_FOLDER") are updated appropriately during deployment.
24-27: Clarified Instructions for Startup and CI Scripts
The reformatting clearly outlines the instructions for modifying startup scripts and CI configuration. This helps users better understand the need to run the rake task before the webpack process.
37-39: Safe Load Options Configuration is Clear
The code snippet for settingconfig.i18n_yml_safe_load_optionsis correctly formatted and self-explanatory.
44-47: Output Format Configuration is Straightforward
The snippet that setsconfig.i18n_output_formatto"js"is well-formatted. Verify that this value aligns with your project requirements.
51-58: Dependencies Version Information is Consistent
The formatting changes in this JavaScript snippet forclient/package.jsonimprove clarity. Please ensure that the specified minimum versions forintlandreact-intlmeet the project's compatibility standards.
84-91: Component Example Code is Clean and Clear
The snippet demonstrating how to usedefaultMessageswithin a component is well formatted and informative.
95-97: Notes Section Formatting Enhances Readability
The reorganization of the notes section, including the links and additional discussion points, substantially improves the document's readability and overall presentation.docs/outdated/rails-assets.md (1)
16-16: Improved Section Spacing: The insertion of a new line before the "The Problem" section (line 16) effectively separates the sections and enhances the document's organization.docs/javascript/capistrano-deployment.md (3)
6-12: Enhanced Ruby Code Block Formatting
The Ruby code block now begins with ````ruby``` (without an extraneous space) which aligns with Prettier’s style. The extra blank line (line 6 and line 12) around the code block also improves separation and visual clarity in the markdown document.
13-18: Shell Command Block Formatting Improvement
Similarly, the shell command block has been updated to usesh``` instead ofsh``` (as seen on lines 15-17). This change is consistent with the overall formatting updates and helps ensure that the code block is correctly highlighted.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
16-16: Dollar signs used before commands without showing output
null(MD014, commands-show-output)
19-24: Consistent Capfile Code Block Formatting
The instructions for updating the Capfile now use a Ruby code block starting with ````ruby``` (lines 21-23) and are appropriately surrounded by newlines. This consistency across different code snippet types contributes to better documentation readability.docs/contributor-info/linters.md (5)
2-2: Minor Formatting Adjustment:
The change on line 2 appears to be a minor whitespace or formatting adjustment to ensure consistency.
12-14: Approved RuboCop Code Block:
The command block for running RuboCop (rubocop -a) is clearly formatted and adheres to the new styling guidelines.
18-20: Approved ESLint Command Block:
The ESLint autofix command block (eslint --fix .) is formatted correctly and enhances readability.
22-22: Approved Inline Separator:
The standalone “or” separator is clearly delineated, aiding users in distinguishing between command alternatives.
24-26: Approved Alternate Command Block:
The code block presenting thenpm run lint -- --fixcommand is well-formatted and consistent with the updated documentation style.docs/javascript/angular-js-integration-migration.md (1)
9-9: Clear Guidance for CSS ModulesThe updated text clearly outlines the move to CSS modules once transitioning to Webpack and appropriately cautions about legacy styling concerns.
docs/javascript/server-rendering-tips.md (2)
22-24: CSS Section Formatting Check
The minor formatting change in the CSS section (adjusting the header spacing and content) looks good and helps maintain consistency across the document.
31-35: Example Command Formatting Verification
The formatting adjustments for the example command section (lines 31–35) appear consistent with the formatting objective of the PR and preserve the intended output.docs/guides/tutorial.md (7)
3-3: Enhanced Emphasis for External Resource Link
The italicized note with the example repository link is a clear, user-friendly styling improvement. The change improves readability and draws attention to the resource.
5-5: Improved Visual Separation with Horizontal Rule
The addition of the horizontal rule (---) immediately after the introductory note helps to visually separate the header from the subsequent content, enhancing document structure.
7-7: Consistent Styling for Version Information
Formatting the version update note in italics (_Updated for Ruby 2.7, Rails 7, React on Rails v13, and Shakapacker v7_) reinforces consistency and readability.
16-18: Clear Listing of Source and Live Links
The reformatting of the bullet list which now distinctly separates the source code PR links and the live app link enhances clarity. No action is required.
22-23: Concise Bulleted Reference Links
The added bullet points for the RubyGems and npm package links improve navigation. This clear presentation of reference material is valuable for the reader.
360-362: Updated Helpful Links for HMR and DevServer
The updated list of links (to webpack-dev-server, DevServer, and Hot Module Replacement) is beneficial for users seeking additional context. The formatting now clearly delineates each resource.
370-372: Updated Procfile.dev for Cloud9 Compatibility
The change to theProcfile.dev(using IP0.0.0.0and port8080) is a practical update for Cloud9 IDE users. Please ensure that this does not conflict with other environments where the default port might be required.docs/misc/style.md (7)
2-2: Enhanced spacing after header improves readability.
The inserted blank line at line 2 creates a clearer visual separation immediately following the "# Code Style" header.
5-7: Improved bullet point formatting for clarity.
The added line breaks before the bullet points in this section enhance the list’s readability and visual structure.
10-11: Better layout in the Client Side section.
The new spacing before the bullet point in lines 10–11 under "## Client Side JavaScript and React" improves layout clarity.
14-14: Spacing adjustment after section header.
The extra line inserted after "## Style Guides to Follow" (line 14) enhances separation between the header and subsequent content.
18-21: Structured presentation in Ruby Coding Standards.
The bullet items added under "### Ruby Coding Standards" organize the resource links effectively.
29-31: Clean formatting for Git Coding Standards.
The inclusion of a dedicated bullet point for the "Git Coding Standards" link improves the visual structure of this section.
33-36: Enhanced clarity in Sass Coding Standards.
The new line breaks and bullet points under "### Sass Coding Standards" provide better clarity and organization of the guidelines.PROJECTS.md (1)
3-3: New Public Sites Search Link Added
The newly added link provides a convenient way to search for public sites using React on Rails. Please verify that the URL is correct and remains accessible.docs/guides/rails-webpacker-react-integration-options.md (3)
127-130: Review React Refresh Webpack Plugin Snippet: Configuration CheckThe snippet updating the configuration to use
ReactRefreshWebpackPluginappears properly formatted and consistent with the intended upgrade. Confirm that this change works harmoniously with the rest of your Webpack configuration.
190-202: Review Sass Loader Diff: Conditional Source Map HandlingThe changes that conditionally set
sourceMapContentstofalsewhenmodule.hotis not present appear correct and should help streamline the development experience. Please double-check that this logic is compatible with all targeted development environments.
207-215: Review Webpack Environment Diff: Alias ConfigurationThe diff that merges an alias for
'react-dom'to'@hot-loader/react-dom'is a good step towards improving hot reloading compatibility. Verify that this alias does not unintentionally conflict with other parts of your Webpack configuration.KUDOS.md (1)
14-14: Bulk Prettier Formatting Adjustments in Timeline EntriesA number of header and section delimiters now include extra newlines (indicated by the ~ markers). These changes improve overall readability and consistency with our Prettier configuration. Please verify that the visual layout in rendered Markdown meets expectations.
Also applies to: 20-20, 26-26, 32-32, 38-38, 44-44, 48-48, 53-53, 57-57, 61-61, 65-65, 69-69, 74-74, 79-79, 83-83, 87-87, 91-91, 97-97, 101-101, 105-105, 111-111
docs/javascript/webpack.md (3)
4-4: Spacing & Readability Enhancement
The inserted blank line before the section header helps visually separate content, improving overall readability.
21-22: Consistent Bullet List Formatting
The reformatted bullet list under the "Entry Points" section now uses dashes consistently, which enhances clarity.
25-25: Improved Section Separation
The additional spacing before the "Webpack v4" header provides better visual separation and reinforces the document’s hierarchical structure.docs/api/view-helpers-api.md (2)
2-3: Enhanced Section Header Presentation
The updated spacing before the header improves the document structure, clearly delineating sections for better readability.
7-8: Effective Content Separation
The insertion of a horizontal rule improves visual separation between different parts of the documentation.docs/guides/webpack-configuration.md (1)
41-43: Uniform Bullet List Style
Changing the bullet points from asterisks to hyphens provides a consistent style with the rest of the document, enhancing uniformity.docs/guides/how-to-use-different-files-for-client-and-server-rendering.md (3)
12-15: Consistent Registration Syntax in Client Entry
Adding the semicolon in theReactOnRails.register({ App });call ensures that the code follows standard JavaScript formatting conventions.
20-23: Consistent Registration Syntax in Server Entry
The updated semicolon in the server entry example maintains consistency and aligns the syntax with common JavaScript practices.
27-28: Clarification Improvement
The new line referencing [Webpack Docs] clearly separates the inline documentation from the preceding content, enhancing clarity.docs/javascript/react-router.md (2)
10-11: Consistent Import Statement Formatting
The semicolons added to the import statements improve consistency with modern JavaScript coding standards.
29-31: Uniform List Formatting for Tutorial Resources
Reformatting the bullet points for the tutorial resource links using hyphens creates a more uniform and clean presentation.docs/javascript/react-helmet.md (11)
4-4: Formatting Enhancement: The new line at line 4 improves the separation between the “Installation and general usage” header and the subsequent content, enhancing readability.
9-9: Improved Section Separation: The inserted line at line 9 after the “## Example” header creates better visual breaks, which aids in distinguishing the sections.
12-12: Clarified Instruction: The updated text at line 12 (“Create a render-function for server rendering like this:”) clearly signals the beginning of the example, making it easier to follow.
33-33: Streamlined Component Export: The change on line 33 — updating the export from
export default (props) => (<App {...props} />);
to
export default (props) => <App {...props} />;
— removes unnecessary parentheses and aligns with concise JSX practices.
36-36: Grammar Check: The static analysis tool flagged a potential missing comma at this line. The sentence appears clear, so please verify if this is a false positive.🧰 Tools
🪛 LanguageTool
[uncategorized] ~36-~36: Possible missing comma found.
Context: .....props} />; ``` Or a render-function. Note you can't return just the JSX (React el...(AI_HYDRA_LEO_MISSING_COMMA)
38-38: Consistent Formatting: The adjustment at line 38 (an extra/new line) helps maintain a consistent separation between descriptive text and subsequent content.
56-57: Code Block Transition: The modified transition before the code block (line 56) now better connects the instructional text (“Put the ReactHelmet component somewhere in your<App>:”) with the following code snippet.
71-71: Section Header Update: The revised header at line 71 (“Register your generators for client and server sides:”) clearly delineates the next instruction block, improving the document’s structure.
90-90: Enhanced Introductory Text: The revision starting at line 90 improves the introduction to the explanation ofreact_component_hash, making the intent clearer to the reader.
94-94: Clarification of Server Rendering Example: The formatting change on line 94 better separates the Ruby code snippet from the surrounding text, enhancing clarity for readers examining the example.
106-106: Enhanced Instruction for Layout Integration: The updated line 106 (“So now we're able to insert received title tag to our application layout:”) now clearly introduces the subsequent code snippet, making the integration instructions more understandable.docs/guides/render-functions-and-railscontext.md (7)
1-1: Document Title Update
The main heading “# Render-Functions and the Rails Context” is now clearly presented. No issues detected.
32-36: JSX Block Formatting
The JSX returned by the inner function is now formatted with clear indentation. This adds to the clarity of the component's output.
45-59: Alternate API Formatting with React.createElement
The alternative implementation usingReact.createElementis now reformatted for clarity. The inline arrow function and associated JSX structure are easier to follow. Verify that this style is applied consistently with similar examples elsewhere in the documentation.
61-61: Consistent Separator Styling
The horizontal rule separator (line 61) is formatted consistently with the rest of the document, helping to delineate different sections clearly.
63-63: Clear Server Rendering Warning Note
The note on potential React browser console warnings during server rendering is now visually distinct. This helps users quickly understand the nuance regarding theserverSideparameter.
114-115: ERB View File Annotation
The annotation “ERB view file:” now clearly indicates the beginning of an example block for ERB usage. This minor formatting update enhances clarity.
136-136: Updated Section Heading
The revised heading “## Why is the railsContext only passed to render-functions?” now better conveys the intent of this section.docs/additional-details/recommended-project-structure.md (5)
18-18: Enhanced Section Header
The new header clearly demarcates the steps for converting to a/clientdirectory. This improves readability and helps users quickly locate the conversion instructions.
29-29: Clear Configuration Update
The code block settingsource_path: clientis concise and correctly formatted. It clearly reflects the intended configuration change for Shakapacker.
37-37: Added Delegation Step
The inclusion of the step to create a/package.jsonthat delegates to/client/package.jsonprovides clear guidance on project restructuring. The step is well-presented and easy to follow.
50-50: Helpful Discussion Link
The inclusion of the discussion link adds valuable context for users considering asset management options. It’s a useful reference that complements the instructions well.🧰 Tools
🪛 LanguageTool
[style] ~50-~50: Consider an alternative adjective to strengthen your wording.
Context: ...s asset pipeline. It depends! Here's a good discussion of this option: [Why does Ra...(GOOD_CONSTRUCTIVE)
63-63: Clear Technique Overview
The description of customizing webpack configuration files for generating CSS, image, and font assets is clear and succinct. This explanation should effectively guide users who opt for a custom asset management setup.docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (9)
13-14: Improve emphasis for server‑side rendering instructions.
The revised markdown now uses enhanced emphasis (i.e. not) to highlight the negation regarding server‑side rendering. This change improves visual clarity; ensure that it is consistently applied throughout similar sections in the docs.
21-23: Streamline server‑side rendering section separation.
Splitting “rendering.” onto its own line and adding a descriptive sub‑header (“## If you use the same Webpack setup for your server and client bundles”) enhances readability. Confirm that the style aligns with the rest of the document.
26-26: Format configuration reference for clarity.
The isolated formatting of the reference toconfig/initializers/react_on_rails.rbmakes it stand out, improving instructional clarity.
34-34: Consistent mapping description for inline setting.
The updated single‑line description fordev_server.inline(with the corresponding link) is clear and concise.
40-41: Standardize error example formatting.
The bullet list now uniformly presents error messages for both HMR (window is not defined) and inline (Cannot read property 'prototype' of undefined). This consistency aids in quickly identifying potential misconfigurations.
48-57: Refine the configuration code block formatting.
The code block outlining thedev_serverconfigurations is now uniformly indented and clearly presented. This makes it easier for users to copy and understand the required settings.
61-62: Clarify package installation instructions.
The instructions for adding react‑refresh packages now stand out with proper formatting. This ensures that users can easily follow the steps in their terminal.
65-67: Improve JavaScript snippet formatting for clarity.
The concise formatting of the lines importingdevServerand determiningisWebpackDevServerincreases readability and consistency within the script block.
102-114: Present tested configuration details clearly.
The restructured list starting at line 102 now clearly communicates the versions and tools used for testing these plugins. This detailed enumeration reassures users of the compatibility and stability of the setup.spec/dummy/README.md (4)
3-4: Removal of Outdated Local Dependency Linking Instructions
The two lines suggesting the use ofyalc linkand the instruction to install yarn dependencies inspec/dummy/clienthave been removed. Please confirm that these steps are no longer needed or that they’ve been relocated to a more appropriate section.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e spec/dummy/client/node_modules to the top level - Be sure to install yarn dependencies ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
12-19: Improved Formatting for Setup Instructions
The “Run yarn if not done yet” section clearly separates command blocks (e.g. the use ofyarn run dummy:install) from other instructions. The formatting now enhances readability without affecting the underlying commands.
38-42: Consistent Presentation for Asset Loading Commands
The updated code block for static Rails asset loading (usingforeman start -f Procfile.dev-static) follows the established style and improves consistency.
43-47: Clear Formatting in the “Creating Assets for Tests” Section
The formatting adjustments in the assets-for-tests section improve clarity and maintain consistency with the rest of the document.CONTRIBUTING.md (6)
3-5: Refined Contributor Information List
The updated bullet list providing links to key contributor docs (Releasing, Pull Requests, etc.) is now clearer and easier to read.
7-10: Enhanced Test Instructions Layout
The spacing and added bullet items in the “To run tests:” section improve readability and help the contributor quickly locate important requirements.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
7-7: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
12-15: Clear Shell Command Presentation
The shell command block is formatted in a way that clearly conveys the steps to prepare all examples. No further changes are necessary here.
17-19: Concise Reference to Setup Resources
The pointers to “Dev Initial Setup” and “Running tests” are now presented succinctly, ensuring that contributors can easily find the relevant sections.
24-34: Well-Organized List of Directories to Ignore
The revised list of directories that should be ignored by the IDE/editor is clear and neatly formatted.
36-39: Straightforward Test App Configuration Instructions
The instructions for configuring your test app to use your local fork are concise and easy to follow.spec/dummy/client/README.md (2)
3-3: Consistent “ESLint” Header
The header for the ESLint section is now standardized.
41-55: Clear “Adding Node Modules” Instructions
The section on adding node modules explains the process well, and the code block (which already uses thebashidentifier) is correctly formatted.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
50-50: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
README.md (3)
21-24: Updated News Section Formatting
The bullet points in the “News” section have been reformatted to improve clarity and ensure consistency with the rest of the document.
25-28: Consistent Section Separation
The introduction of a horizontal rule (lines with---) and the emphasis on the current docs version contributes to a clearer separation between sections.
109-112: Enhanced “Work with Us” Call to Action
The “Work with Us” section is prominently formatted and effectively highlights the call to action for potential collaborators.docs/contributor-info/pull-requests.md (2)
22-24: Adjust Heading Level for Consistency
The header “#### The seven rules of a great git commit message” should be adjusted to “### The seven rules of a great git commit message” so that heading levels increment properly. This comment echoes a previous suggestion.-#### The seven rules of a great git commit message +### The seven rules of a great git commit message
38-45: Enhanced Formatting for Documentation Links
The adjustments in the “Links to other docs” section (using relative URL paths and proper indentation) improve overall readability.docs/getting-started.md (7)
10-10: Clarify reordered numbered list
The example for "Look at [github.com/shakacode/react-webpack-rails-tutorial]..." is now listed as item 4. This reordered sequence improves clarity.
53-53: Helpful Tip for JS Runtime Environment
The added note about settingEXECJS_RUNTIME=Nodeto use Node as the JS runtime is useful for troubleshooting. Make sure this recommendation is consistent with other parts of the documentation if similar runtime setups are discussed.
72-74: Refined Configuration Instructions
The configuration section has been updated to emphasize the Shakapacker setup and de-emphasize manual changes toconfig/initializers/react_on_rails.rb. Please verify that the removal (or demotion) of the initializer configuration is intentional, so users aren’t left without guidance if they need to adjust settings.
116-118: Improved HTML Tag Formatting
Changing the self-closing tag from<br/>to<br />improves consistency with modern HTML standards. The component snippet is now clearer.
134-138: Cleaner Code Snippet Formatting for JS Bundle
The JavaScript snippet in the hello-world-bundle now includes a file comment and spaced imports. This makes the snippet easier to understand.
166-172: Render-Function Closure Check
The Render-Function (MyComponentGenerator) now concludes with a clean closure. No issues are observed here.
194-195: Concise Error Handling Listing
The bullet points outlining error handling for ReactOnRails are now concise and clear. No further changes are necessary.docs/contributor-info/generator-testing.md (3)
2-2: Formatting Enhancement: Blank Line Addition
The insertion of a blank line improves readability by providing a clearer separation after the header.
8-8: Formatting Enhancement: Section Separation
Adding a blank line before the "Travis and Gemfiles" section improves visual separation and readability.
13-13: Readability Improvement: Section Introduction
The additional blank line before the "Configuring what Apps are Generated" section creates a clearer break between sections, which enhances overall readability.docs/home.md (3)
4-4: Formatting Improvement: Enhanced Header-to-Content Separation
The updated formatting immediately following the "## Details" header creates a cleaner transition into the list, boosting the document's clarity.
14-14: Section Demarcation Improvement
The added blank line under the "## Example Apps" header provides clearer visual separation from preceding sections, making it easier for readers to navigate the content.
20-20: Consistent Readability Enhancement
Inserting a blank line before the "Other Resources" section creates a consistent and clear structure, aligning with the overall formatting improvements in the document.docs/guides/client-vs-server-rendering.md (1)
3-3: Consistent Emphasis Formatting
Changing the emphasis from asterisk to underscore helps maintain uniform formatting standards across the documentation.docs/outdated/rails-assets-relative-paths.md (12)
40-40: JavaScript Loader Configuration Formatting
The snippet now uses single quotes and includes a trailing comma, which aligns perfectly with the updated Prettier settings.
46-49: Consistent JSON Syntax for Loader Query Parameters
The JSON snippet now uses single quotes for string values and includes proper trailing commas. This enhances readability and consistency with project formatting guidelines.
55-57: Object Key Notation in Alias Configuration
Using single quotes for the key'assets'is acceptable as it maintains consistency with the updated formatting rules.
63-65: File Naming Pattern Configuration
The file naming pattern using single quotes (i.e.name: '[name][md5:hash].[ext]',) is now clear and consistent. Please verify that the[md5:hash]syntax is interpreted as expected by file-loader.
70-73: OutputPath Formatting Update
TheoutputPathproperty now uses single quotes and a trailing comma, adhering to the updated Prettier style guidelines.
83-85: PublicPath Configuration Consistency
ThepublicPathproperty is now defined with single quotes, ensuring consistency across the configuration snippets.
94-96: Consistent Import Statement Formatting
The JavaScript import statement now uses single quotes, which aligns with the project’s updated formatting rules.
135-136: Webpack Entry Configuration Update
The entry point array is formatted using single quotes, in line with the updated Prettier configuration for the project.
139-141: Output Configuration Consistency
The output configuration block now expresses the path using single quotes, matching the overall style improvements.
155-157: DefinePlugin Configuration Formatting
The adjustments in the DefinePlugin block (notably the use of single quotes and trailing commas) ensure that this configuration is consistent with the new formatting settings.
171-174: Module Rule – Imports Loader Options Formatting
Theimports-loaderoptions now have cleaner formatting with appropriate indentation and trailing commas, which enhances readability.
182-185: File-loader Options Formatting
The file-loader options, including both theoutputPathandpublicPathproperties, are now consistently formatted using single quotes.docs/release-notes/15.0.0.md (4)
6-9: Clarified React Server Components Support SectionThe added bullet for "- Seamlessly use React Server Components" and the accompanying text enhance the description of RSC integration. Ensure that the bullet formatting (e.g. punctuation and capitalization) is consistent with the rest of the release notes.
14-17: Enhanced Improved Component Hydration SectionThe updated header and introductory text now better emphasize that components and stores will hydrate immediately rather than waiting for full page load. This aligns well with the asynchronous enhancements introduced elsewhere in the release notes.
36-39: Update on AsynchronousreactOnRailsPageLoaded()UsageThe updated explanation now instructs developers that
ReactOnRails.reactOnRailsPageLoaded()is asynchronous and must be awaited when manually called. This change is critical for ensuring that component hydration occurs reliably. Confirm that all relevant developer guides and documentation are updated accordingly.
40-48: Consistent Before/After Code Snippet FormattingThe provided JavaScript snippet clearly demonstrates the change—from a simple function call to properly awaiting the promise returned by
ReactOnRails.reactOnRailsPageLoaded(). Please verify that indentation and code block formatting remain consistent in the final rendered documentation.docs/misc/doctrine.md (8)
12-12: Formatting Improvement: Enhanced Readability in the “Optimize for Programmer Happiness” SectionThe introductory statement for this section is now clearly separated, which improves readability.
35-35: Formatting Update: Improved Transition for “The Menu Is Omakase”The revised introductory line now smoothly leads into the chef’s selection section.
39-44: Bullet List Update: Libraries SectionThe libraries are now listed in a clean, consistent bullet format that enhances clarity.
47-49: Consistent Formatting: JavaScript Tooling ListThe bullet list under “JavaScript Tooling” is now uniformly styled and easy to read.
54-54: Clarity Enhancement: Omakase ClarificationThis line now clearly differentiates the Rails standard from non-standard (CoffeeScript) approaches, which makes the intended message more accessible.
73-73: Clear Commitment: Active Development PaceThis line clearly communicates the project’s commitment to maintaining an active pace of development.
77-77: Emphasis on Inclusivity: Big Tent ConceptThe repetition of “big tent” effectively emphasizes both the project’s inclusivity and its flexible integration. This intentional emphasis is clear and impactful.
81-81: Final Thanks Section: Inviting and Well-FormattedThe closing message is engaging and the call to action (issue submission or email) is clearly presented.
docs/guides/file-system-based-automated-bundle-generation.md (9)
8-9: Formatting Improvement for Nested Entries Configuration
The updated wording clarifies how to setnested_entries: truein theshakapacker.ymlfile, which improves overall readability.
42-47: Enhanced Readability for Generated Files Section
The restructuring and added line breaks in this section improve clarity on where the generated files will be placed.
49-50: Gitignore Update Formatting
The minor formatting changes in the.gitignoresection help emphasize which generated files to ignore.
58-67: Consistent Formatting for Server Bundle Entry Point Import
The formatting adjustments in this section, including the clearer presentation of the import statement, enhance consistency. Please verify that the relative import path remains correct.
73-74: Improved Readability in Background Section
The insertion of an extra line break in this part of the document improves the overall readability without altering the content.
154-159: Refined Layout Example Formatting
The reformatting of the layout code block makes the example easier to follow. The updated indentation and spacing contribute to improved clarity in demonstrating the intended usage.
182-187: Well-Formatted Rails View Example
The example Rails view code block is now clearly delineated and properly highlighted with the language (erb), which aids readability.
189-201: Clear Example forreact_component_hashUsage
The code snippet demonstrating the usage ofreact_component_hashis easy to read and follows appropriate formatting conventions.
211-211: Clear Inline Note for Server/Client Rendering
The inline note regarding the need to delete the generalizedComponentName.jsxfile, when separate definitions are provided, is concise and clearly separated from the surrounding text.NEWS.md (1)
3-3: Improved Introductory Formatting.
The introductory text now uses italics, which enhances readability and provides a softer introduction to the changelog. Ensure this style is applied consistently across similar documentation.docs/guides/upgrading-react-on-rails.md (32)
4-5: Added Migration Help Contact Section
The new "Need Help Migrating?" section provides clear contact information for React on Rails Pro Support. This addition helps users know where to get assistance during upgrade.
11-13: Clarify Breaking Change Messaging
The "Breaking Change" section now emphasizes the deprecation of the webpacker gem in favor of shakapacker. Ensure that this message is consistent with other upgrade documentation and that version numbers or migration procedures are clearly referenced where needed.
26-29: New Section for Upgrading to v12
The header and introductory lines for the v12 upgrade provide important requirements (e.g. minimum Rails/webpacker versions) and a note about filing an issue for unsupported versions. Consider a brief clarification on what “recent versions” means to avoid ambiguity.
33-36: Deprecated Configuration Notice
The section titled “Removed Configuration config.symlink_non_digested_assets_regex” clearly instructs users to remove this setting from their initializer. Verify that any related migration notes elsewhere in the docs are updated accordingly.
56-57: Explanation of Registered Function Cases (Case 1)
The instructions for functions that take zero or one parameter and return a React Element are now clearly listed. The explanation is succinct and indicates no migration is needed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~56-~56: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ction that takes only zero or one params and you return a React Element**, often JSX...(COMMA_COMPOUND_SENTENCE)
58-61: Code Example for Case 1 – No Migration Needed
The provided code snippet showing a function returning a React element is well formatted and easy to understand.
69-83: Guidance for Adjusting Function Signatures to Exactly Two Parameters
The added text and accompanying code examples clarify how to modify functions so they have exactly 2 parameters (using an unused parameter if necessary). The instructions are clear; just ensure that the example is consistent with your overall migration strategy.
102-107: Clarify Broken Code Example
The "Broken" example is meant to illustrate a common mistake by returning a JSX literal directly; however, the snippet shows mismatched braces in<Component {{...props, railsContext} />. Confirm that the example accurately represents the erroneous pattern so users can easily recognize and avoid this pitfall.
117-120: Corrected JSX Example for Two-Parameter Case
The fixed code snippet illustrates the correct approach—wrapping the component in an additional function call. This makes the example clear and instructive.
127-127: Section Separator Added
The horizontal divider (---) helps break up the document sections and improve readability.
130-132: Introducing Webpacker v3 to v4 Upgrade Section
The new header and introductory lines for upgrading from rails/webpacker v3 to v4 set the stage for important configuration changes. Ensure that these instructions are consistent with the rest of the upgrade guide.
135-139: YAML Configuration Example for CSS Extraction
The YAML snippet clearly demonstrates how to enable CSS extraction viaextract_css: true. It might help to briefly mention the practical impact of this change (e.g. “ensures that a CSS file is generated and linked correctly”).
142-146: Upgrade Instructions for Version 11
The segment detailing the removal of deprecated methods (such asserver_render_methodand usage of ENV["TRACE_REACT_ON_RAILS"]) is concise and useful. Cross-check that these instructions mirror any code changes made in the upgrade.🧰 Tools
🪛 LanguageTool
[uncategorized] ~144-~144: The preposition “by” seems more likely in this position.
Context: ..._RAILS"] usage. You can get all tracing with either specifyingtraceat your c...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
🪛 markdownlint-cli2 (0.17.2)
143-143: Bare URL used
null(MD034, no-bare-urls)
148-153: Upgrading to Version 10 Guidance
The migration steps for version 10 are succinctly listed. Ensure that users understand the shift from usingreact_componenttoreact_component_hashif applicable.
155-162: Upgrading to Version 9 – Benefits of Webpacker
The section explaining why Webpacker is valuable, detailing features like bypassing double minification and enabling source maps, is informative. Verify that the benefits are still accurate relative to the latest best practices.
164-170: Integrating Webpacker: Rationale and Initial Steps
The “Integrating Webpacker” section explains how bypassing the Rails asset pipeline can be advantageous. The instructions under “From version 7 or lower – ...while keeping yourclientdirectory” are clear and help guide the upgrade process.🧰 Tools
🪛 LanguageTool
[uncategorized] ~165-~165: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ndles to bypass the Rails asset pipeline and it's extra minification, enabling you t...(COMMA_COMPOUND_SENTENCE)
171-176: Detailed Integration Instructions for Client Directory
The bullet list detailing changes (such as updating.gitignore, modifying the Gemfile, and altering asset configuration) is very useful. Confirm that the file paths and instructions reflect the current repository structure.🧰 Tools
🪛 LanguageTool
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ... yourclientdirectory -.gitignore: add/public/webpack/*-Gemfile: bu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ...config/initializers/react_on_rails.rb: - Delete `config.generated_assets_dir...(UNLIKELY_OPENING_PUNCTUATION)
177-180: Configuration File Updates for ReactOnRails
The instructions to deleteconfig.generated_assets_dirand update npm build commands (toconfig.build_(test|production)_command) are clearly stated.🧰 Tools
🪛 LanguageTool
[grammar] ~178-~178: The verb ‘Replace’ is plural. Did you mean: “replaces”? Did you use a verb instead of a noun?
Context: ...onfig now supplies this information - Replace `config.npm_build_(test|production)_com...(PLURAL_VERB_AFTER_THIS)
[uncategorized] ~179-~179: A comma might be missing here.
Context: ...commend setting dev_server.hmr to false however since HMR is currently broken. - `clien...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~180-~180: Loose punctuation mark.
Context: ...urrently broken. -client/package.json: bumpreact_on_rails(I recommend bump...(UNLIKELY_OPENING_PUNCTUATION)
181-181: Package Update Note
A brief note indicating that theclient/package.jsonshould bumpreact_on_rails(and possiblywebpack) is clear and to the point.
182-194: Client Webpack Configuration Snippet
The code snippet that shows how to load configuration usingreact-on-rails/webpackConfigLoaderis well presented and helps set up the remainder of the webpack configuration guide.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
182-182: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
186-186: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
195-203: Webpack Output Settings Example
The provided code snippet for configuring webpack’s output (including filename patterns and cache busting via chunkhashes) is clear. It would be beneficial to cross-reference these settings with any other parts of the documentation discussing cache invalidation strategies.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
197-197: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
205-213: ManifestPlugin Configuration
The snippet showing the configuration ofwebpack-manifest-pluginis straightforward. It clearly demonstrates how to link the public path and enable file emission for the manifest.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
207-207: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
220-229: Instructions for Replacing the Client Directory
The guidance on how to either move source code toapp/javascript/packsor alternatively restructure theclientdirectory is comprehensive. Making sure these instructions are consistent with any automated migration scripts (if available) could be helpful.🧰 Tools
🪛 LanguageTool
[grammar] ~225-~225: This phrase is duplicated. You should probably use “Run Run” only once.
Context: ...rade RoR in theclient/package.json- Runbundle- Runrails webpacker:install- Runrails webpacker:install:react- Runrails g react_on_rails:install- Move...(PHRASE_REPETITION)
230-234: Alternative Migration Strategies Clarified
The “Either:” bullet list provides users with two clear migration paths. This flexibility is appreciated; ensure that further documentation or examples are available for both approaches as needed.
236-239: Reference Example for Version 8 Upgrades
Referring to an external pull request (react-webpack-rails-tutorial/pull/416) is a good way to provide context. Verify that the link remains accessible and reflects the intended migration challenges.
240-247: Breaking Configuration Changes Overview
The segment detailing breaking changes (including the newconfig.node_modules_locationand the renaming of build commands) is comprehensive. A brief explanation of why each change was necessary could further aid developer understanding.🧰 Tools
🪛 LanguageTool
[style] ~242-~242: This phrase is redundant. Consider using “inside”.
Context: ...toconfig/initializers/react_on_rails.rbto keep your node_modules inside of/client2. Renamed - config.npm_b...(OUTSIDE_OF)
248-253: Gemfile Update for Webpacker Integration
The instruction to update the Gemfile by switching to the webpacker gem, accompanied by a clear Ruby code snippet, is concise and clear.
267-277: Updated Webpack Output Example
The provided example showing how to adjust your webpack configuration—especially the conditional filename setting based on HMR—is clear and instructive.🧰 Tools
🪛 LanguageTool
[formatting] ~269-~269: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...name,** unless the bundle is server side.: ``` const webpackConfigLoader ...(DOUBLE_PUNCTUATION_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
271-271: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
301-306: Default Cache Manifest Settings for Different Environments
The code snippet clarifying default settings forcache_manifestin development versus production is clear. It might be useful to add a sentence clarifying how these settings impact asset caching.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
303-303: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
320-321: Public Output Path Renaming
Renamingwebpack_public_output_dirtopublic_output_pathis concisely noted. Cross-check that all related documentation reflects this change.
322-326: Procfile.dev Update for Dev Server Settings
The guidance to remove theWEBPACKER_DEV_SERVERenvironment variable from Procfile.dev and adjust the HMR settings inwebpacker.ymlis clear and practical.
327-335: Guidance for Projects Without Integrating Webpacker
The alternative instructions for projects that choose not to use webpacker (including version bumps and configuration changes in initializers) are well structured.docs/rails/turbolinks.md (11)
3-4: Header Clarity and Relevance
The header “## React on Rails Updated to support Turbo, August 2024” is now clearly marked. Please verify that the date is accurate and will remain relevant as time passes.
5-7: Bullet List for PR References and Turbo Support
The bullet items linking to PR 1620 and PR 1374—and the note on Turbo support replacing Turbolinks—are now formatted consistently. Ensure the links remain valid.
32-34: Requirements List Formatting
The “## Requirements for Using Turbolinks” header and its introductory list are now separated clearly. The formatting improvement adds readability.
48-59: Install Checklist – Enhanced Readability
The “### Install Checklist” section, including the modified ERB code block and note for Turbolinks 2.x, is now formatted clearly.
75-78: Turbolinks from NPM Code Example
The code snippet that imports Turbolinks and callsTurbolinks.start()is concise and clear.
104-107: Troubleshooting Section Introduction
The introduction to the “## Troubleshooting” section is now formatted with clear spacing. No further issues noted.
108-113: Tracing Options Code Block Clarity
The code block that setsReactOnRails.setOptions({ traceTurbolinks: true, turbo: true })is clear and follows proper formatting.
117-121: Defining the DevBuild Constant
The constant definition (const devBuild = process.env.NODE_ENV !== 'production';) is clearly presented. A brief inline comment explaining its purpose might further aid readability for new contributors.
123-131: DefinePlugin Option Configuration
The code block for adding theDefinePluginoption (withTRACE_TURBOLINKS: devBuild) is now well formatted, enhancing clarity.
150-150: jQuery and Turbolinks Compatibility Note
The note on potential issues when using the Ruby gem version of jQuery and jQuery ujs is clear and useful.🧰 Tools
🪛 LanguageTool
[uncategorized] ~150-~150: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...y gem version of jQuery and jQuery ujs. Therefore we recommend using the node packages in...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
152-153: Image Embedding
The embedded image appears correctly formatted. Ensure the image URL remains accessible over time.
docs/getting-started.md
Outdated
| { | ||
| renderedHtml: { | ||
| componentHtml, customKey1, customKey2; | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
JavaScript Object Example Syntax
In the example for using react_component_hash, the object literal shows:
{
renderedHtml: {
componentHtml, customKey1, customKey2;
}
}A semicolon is used after customKey2, which is invalid syntax in an object literal. If the intent was to show valid JavaScript, consider replacing the semicolon with either nothing or a comma.
Proposed diff:
- componentHtml, customKey1, customKey2;
+ componentHtml, customKey1, customKey2| - If we want to keep the original behavior of `force_load` for only one or more components, you can set `force_load: false` in the `react_component` helper or `force_load` configuration. | ||
| - Redux store support `force_load` option now and it uses `config.force_load` value as the default value. Which means that the redux store will hydrate immediately as soon as its server-side data reaches the client. You can override this behavior for individual redux stores by setting `force_load: false` in the `redux_store` helper. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Remove Duplicate Redux Store Configuration Information
The bullet describing Redux store support for the force_load option is repeated (lines 33 and 34). Removing the duplicate entry will help prevent redundancy and potential confusion.
🧰 Tools
🪛 LanguageTool
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...zers/react_on_rails.rbfile. - If we want to keep the original behavior offorce_lo...
(REP_WANT_TO_VB)
[uncategorized] ~34-~34: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ce_loadconfiguration. - Redux store supportforce_loadoption now and it usesco...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~34-~34: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ux store support force_load option now and it uses config.force_load value as th...
(COMMA_COMPOUND_SENTENCE)
| - 2017-02-28: Upgrade to Webpack v2 or use the `--bail` option in your webpack script for test and production builds. See the discussion on [PR #730](https://github.com/shakacode/react_on_rails/pull/730). | ||
| - 2016-11-03: Spoke at [LA Ruby: "React on Rails: Why, What, and How?"](http://www.meetup.com/laruby/events/234825187/). [Video and pictures in this article](https://blog.shakacode.com/my-react-on-rails-talk-at-the-la-ruby-rails-meetup-november-10-2016-eaaa83aff800#.ej6h4eglp). | ||
| - 2016-12-20: New Video on Egghead.io: [Creating a component with React on Rails](https://egghead.io/lessons/react-creating-a-component-with-react-on-rails) | ||
| - 2016-11-03: Spoke at [LA Ruby, 7pm, Thursday, November 10 in Venice, CA: "React on Rails: Why, What, and How?"](http://www.meetup.com/laruby/events/234825187/). [Video and pictures in this article](https://blog.shakacode.com/my-react-on-rails-talk-at-the-la-ruby-rails-meetup-november-10-2016-eaaa83aff800#.ej6h4eglp). |
There was a problem hiding this comment.
Verify Date Consistency in LA Ruby Event Entry.
The entry on line 29 mentions “2016-11-03” alongside “Thursday, November 10” which appear inconsistent. Please verify and correct the event’s date and day of week to ensure historical accuracy.
🧰 Tools
🪛 LanguageTool
[inconsistency] ~29-~29: Did you mean to refer to the current year? November 10, 2025 is not a Thursday, but a Monday.
Context: ...) - 2016-11-03: Spoke at [LA Ruby, 7pm, Thursday, November 10 in Venice, CA: "React on Rails: Why, Wh...
(EN_DATE_WEEKDAY_CURRENTYEAR)
| ```js | ||
| export default (props, railsContext) => () => <Component {{...props, railsContext}} />; | ||
| ``` |
There was a problem hiding this comment.
Review JSX Example for Two-Parameter Functions
The code snippet for functions that “take 2 params and return a React function or class component” contains extra curly braces in <Component {{...props, railsContext}} />; which appears nonstandard in JSX. Please verify whether this syntax is intentional. Typically, a correct example might be <Component {...props} railsContext={railsContext} /> or a similar valid structure.
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
from
052a59d to
4a495f3
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/getting-started.md (1)
183-188:⚠️ Potential issueJavaScript Object Syntax Correction Required
A semicolon is used aftercustomKey2in this object literal, which is invalid JavaScript syntax. Please remove the semicolon to produce a valid object declaration.- componentHtml, customKey1, customKey2; + componentHtml, customKey1, customKey2
🧹 Nitpick comments (106)
docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md (1)
10-10: Markdown URL Formatting: Consider Updating Bare URL.
Line 10 uses a bare URL which may trigger markdown lint warning MD034 ("no bare URLs"). It is recommended to wrap the URL in angle brackets (e.g.,<https://github.com/shakacode/shakapacker/tree/master/lib/install/bin>) or convert it to a markdown link to improve compliance with markdown styling guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Bare URL used
null(MD034, no-bare-urls)
docs/outdated/rails3.md (2)
3-3: Improve the wording for clarity and assertiveness.
The sentence "Please let us know if you find any issues with Rails 3." could be reworded to a more direct call to action, for example: "Report any issues with Rails 3 that you encounter."🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Consider using a different verb to strengthen your wording.
Context: # Rails 3 - Please let us know if you find any issues with Rails 3. - Rails 3 is c...(FIND_ENCOUNTER)
5-5: Refine the call-to-action for issue reporting.
Instead of "We are not testing it for new releases. If you find an issue, you will have to submit a PR to get it fixed," consider rephrasing to encourage community involvement, for example: "We do not test new releases. If you encounter any issues, please submit a PR to address them."🧰 Tools
🪛 LanguageTool
[style] ~5-~5: Consider using a different verb to strengthen your wording.
Context: ...not testing it for new releases. If you find an issue, you will have to submit a PR ...(FIND_ENCOUNTER)
docs/rails/rails-engine-integration.md (1)
35-38: Revise terminology in GitHub Issues linkThe bullet point on line 36 states:
- [Feature: target destination option for the install generator #459](https://github.com/shakacode/react_on_rails/issues/459)The static analysis hint suggests that “install” is not used as a noun. Consider rephrasing it to use a more appropriate term, for example, “installation generator”. Here’s a suggested diff:
- [Feature: target destination option for the install generator #459](https://github.com/shakacode/react_on_rails/issues/459) + [Feature: target destination option for the installation generator #459](https://github.com/shakacode/react_on_rails/issues/459)🧰 Tools
🪛 LanguageTool
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...ture: target destination option for the install generator #459](https://github.com/shak...(A_INSTALL)
docs/additional-details/manual-installation-overview.md (1)
21-22: Formatting and Minor Grammar Enhancements NeededIn the Rails Steps section, the updated line now reads:
1. Add \gem "webpacker"` to the Gemfile, run bundle. The gem provides the `stylesheet_pack_tag` and `javascript_pack_tag` helpers which is used to load the bundled assets to your layouts.Dummy Example`Please consider the following improvements:
- Grammar Correction: Change "which is used" to "which are used" to agree with the plural “helpers.”
- Punctuation: A comma after "run bundle" may improve clarity, e.g., "Add
gem "webpacker"to the Gemfile, run bundle, and then note that the gem provides..."These adjustments will align the language with formal documentation standards.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...eet_pack_tagandjavascript_pack_tag` helpers which is used to load the bundled asset...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...andjavascript_pack_taghelpers which is used to load the bundled assets to your...(AI_HYDRA_LEO_CPT_IS_ARE)
docs/deployment/elastic-beanstalk.md (2)
45-45: Grammar Improvement: Add Missing Comma.
A comma is suggested after "/home/webappdirectory" to improve clarity. Consider revising the sentence to:"This script installs
yarnand allnode.jsdependencies before the Rails doassets:precompile. Also, it creates/home/webappdirectory, allowing the precompile task to create temp files."🧰 Tools
🪛 LanguageTool
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...mpile. Also, it creates/home/webapp` directory allowing the precompile task to create ...(AI_HYDRA_LEO_MISSING_COMMA)
47-47: Capitalization Correction: Use "React" Instead of "react".
Proper nouns like "React" should be consistently capitalized. Please change "react app javascript" to "React app javascript" to maintain correct naming conventions.🧰 Tools
🪛 LanguageTool
[grammar] ~47-~47: “React” is a proper noun and needs to be capitalized.
Context: ...ic beanstalk successfully. However, the react app javascript files are under `public/...(A_GOOGLE)
docs/javascript/webpack-v1-notes.md (1)
7-8: Formatting Improvement: Enhanced Explanation for the--bailOptionThe added text clearly explains the benefits and caveats of using the
--bailoption, which is great for ensuring that deployments halt on error. However, to maintain a professional tone, consider moderating the exclamation mark usage and tightening the punctuation. For example, adding a comma before "and you want" can improve readability.-... if you just want to depend on Webpack returning a non-zero error code and you want to see all the errors, rather than only the first error. +... if you just want to depend on Webpack returning a non-zero error code, and you want to see all the errors, rather than only the first error.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1166 characters long)
Context: ...ment halt if Webpack cannot complete! For more details, see the documentation...(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~7-~7: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Webpack returning a non-zero error code and you want to see all the errors, rather ...(COMMA_COMPOUND_SENTENCE)
docs/testimonials/resortpass.md (1)
3-3: Merged Paragraph & Text Quality SuggestionsThe merged paragraph in line 3 appears to be a formatting change applied by Prettier. Ensure that the consolidation into a single block maintains readability and is consistent with the document’s style.
Additionally, please consider these language improvements as flagged by static analysis:
- Capitalization: Change "react on rails application" to "React on Rails application" to correctly reflect the proper noun.
- Adjective Choice: Review the adjective used (e.g., "sophisticated") to determine if a stronger alternative may better convey the intended quality.
🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Consider an alternative adjective to strengthen your wording.
Context: ...ted code that both works and reflects a deep understanding of the technologies and p...(DEEP_PROFOUND)
[grammar] ~3-~3: “React” is a proper noun and needs to be capitalized.
Context: ...s and standards for our transition to a react on rails application. Just three months...(A_GOOGLE)
docs/guides/how-react-on-rails-works.md (1)
5-5: Emphasis Style Consistency
The updated text now uses underscores for emphasis (i.e._recommended_), but according to markdownlint (MD049) the expected style is asterisk-based emphasis (i.e.*recommended*). If your project’s style guidelines (or the Prettier configuration) require asterisks for emphasis, please consider updating this accordingly.-Webpack is used to generate JavaScript and CSS "bundles" directly to your `/public` directory. [Shakapacker](https://github.com/shakacode/shakapacker) provides view helpers to access the Webpack-generated (and fingerprinted) JS and CSS. These files totally skip the Rails asset pipeline. You are responsible for properly configuring your Webpack output. You will either use the standard Webpack configuration (_recommended_) or the `shakapacker` setup for Webpack. +Webpack is used to generate JavaScript and CSS "bundles" directly to your `/public` directory. [Shakapacker](https://github.com/shakacode/shakapacker) provides view helpers to access the Webpack-generated (and fingerprinted) JS and CSS. These files totally skip the Rails asset pipeline. You are responsible for properly configuring your Webpack output. You will either use the standard Webpack configuration (*recommended*) or the `shakapacker` setup for Webpack.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
5-5: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
docs/javascript/angular-js-integration-migration.md (1)
6-7: Minor Grammar and Style Improvements in "Assets Handling" SectionIn the line starting at 7, consider revising:
- Change "setup" to "set up" to use the verb form.
- Replace "no different than" with "no different from" for enhanced formal style.
These tweaks will help polish the document's language consistency.
🧰 Tools
🪛 LanguageTool
[grammar] ~7-~7: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ave not already done this, then you can setup theReactOnRailsdefault JS code dire...(NOUN_VERB_CONFUSION)
[style] ~7-~7: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style.
Context: ...inclusion this way will be no different than using the Rails asset pipeline. However...(DIFFERENT_THAN)
[uncategorized] ~7-~7: “you” seems less likely than “you’re” (you are).
Context: ...ils asset pipeline. However, so long as you understand how your JavaScript will e...(AI_HYDRA_LEO_CP_YOU_YOUARE)
docs/outdated/rails-assets.md (3)
3-3: Refine the Documentation Notice MessageThe newly added italicized notice warns readers that the documentation is outdated regarding Shakapacker/rails‑webpacker usage with React on Rails. Consider rephrasing it for clarity and consistency. For example, you might change it to:
This documentation is outdated and needs to be updated to reflect the usage of Shakapacker or rails/webpacker with React on Rails.
8-9: Ensure Consistent Blockquote FormattingSplitting the blockquote across two lines helps readability. Additionally, to improve clarity, consider inserting a comma after "By default". For example:
- > By default the filename of the resulting file is the MD5 hash of the file's contents with + > By default, the filename of the resulting file is the MD5 hash of the file's contents with🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: Did you mean: “By default,”?
Context: ...e other term for this is a "digest". > By default the filename of the resulting file is t...(BY_DEFAULT_COMMA)
36-39: Clarify and Standardize the Symlink Solution NoteThe added italicized note clarifies that the symlink solution was removed in v14 and advises users to create a GitHub issue if they are interested. To improve clarity and conform to conventional style, consider rewording it as follows:
Note: This solution was removed in v14. If you are interested in this symlink solution, please create a GitHub issue.
-_Note, this solution was removed in v14. If you're interested in this symlink solution, please create -a github issue._ +_Note: This solution was removed in v14. If you are interested in this symlink solution, please create a GitHub issue._docs/javascript/webpack.md (1)
5-5: Editorial Suggestion: Add an Article for Grammatical Clarity
Consider modifying the phrase "example app" to "an example app" for improved grammatical correctness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: You might be missing the article “an” here.
Context: ... "Code Splitting", etc You can try out example app, [shakacode/react-webpack-rails-tut...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
PROJECTS.md (4)
3-3: Check URL Encoding in Public Search Link
The added link for searching public React on Rails sites looks helpful. Please verify that the%22(double-quote) in the URL is intentional and that the URL encoding meets the project’s conventions.
10-10: Review Italics Formatting in Support Message
Changing the support message to use underscores for italicization is acceptable. However, consider whether a subtle punctuation adjustment—such as inserting a comma before the clause starting with "as the source will contain"—could enhance clarity. A static analysis hint noted a possible missing comma.🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...You can confirm a project uses React on Rails as the source will contain **`js-react-...(AI_HYDRA_LEO_MISSING_COMMA)
13-37: Enhance Consistency in the Commercial Products List
The new commercial products section is structured neatly with bullet points. A few minor suggestions:
- For entries like line 15 ("[RedFlagDeals], Canadian shopping site") and line 22 ("[KissKissBankBank], large French crowdfunding platform"), consider adding the article "a" for improved clarity (e.g., "a Canadian shopping site" and "a large French crowdfunding platform").
- On line 29, consider standardizing "multi-lingual" to "multilingual" for consistency.
These small adjustments can further polish the language and maintain stylistic consistency across the document.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...eals](https://www.redflagdeals.com/)**, Canadian shopping site. - **[YourMechanic](https...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~22-~22: You might be missing the article “a” here.
Context: ...](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. - **[HVMN...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~29-~29: This word is normally spelled as one.
Context: ...has gone live with React on Rails, with multi-lingual JavaScript support! ![2016-05-03_19-1...(EN_COMPOUNDS_MULTI_LINGUAL)
56-62: Review the Projects Based on React on Rails Section
The bullet list in this section is clear and follows the overall document style. One minor note: if any compound adjectives (if present) require hyphenation for clarity, adjust as needed per the project’s style guidelines. This is optional but worth verifying.🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ps://github.com/sharetribe/sharetribe): Open source marketplace platform.(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/i18n.md (2)
29-34: Clarify List Formatting with PunctuationThe instruction note now clearly presents the two options for fixing potential lint failures; however, the list could be slightly improved for clarity. Consider adding a comma after the first option to read as:
- 1. run the rake task to build the translations before running the lint command or + 1. run the rake task to build the translations before running the lint command, orThis small punctuation change will enhance readability for users.
🧰 Tools
🪛 LanguageTool
[grammar] ~29-~29: Normally, after “try to” a verb is expected.
Context: ...k process as well. Note: if you try to lint before running tests, and you depend on...(WANT_TO_NN)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...he translations before running the lint command or 2. to run the tests first. 4. If...(AI_HYDRA_LEO_MISSING_COMMA)
62-82: Typographical Correction Needed in React-Intl InitializationWithin this code block, the comment on line 70 contains a typo:
- // Initizalize all locales for react-intl. + // Initialize all locales for react-intl.Correcting the spelling will improve the professionalism of the documentation.
docs/misc/style.md (3)
5-7: Improved Bullet List Structure
The added bullet points clearly outline the key points under the introduction. Consider reviewing the phrasing of "Anything additional goes next." to see if it might benefit from slight rewording or hyphenation based on context (as hinted by static analysis) for optimal clarity.
38-39: Refinement Suggestion for Git Usage Description
The "Git Usage" section is clearer with the inserted blank line and bullet point. However, consider rephrasing “branch off of master” to “branch from master” for improved clarity and conciseness.🧰 Tools
🪛 LanguageTool
[style] ~39-~39: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...ow a github-flow model where you branch off of master for features. - Before merging a...(EN_WORDINESS_PREMIUM_OFF_OF)
40-40: Comma Insertion for Improved Readability
In the long instruction at line 40, inserting a comma after “communicate with anybody else working on this branch” could improve the sentence flow. For example:"Before merging a branch to master, rebase it on top of master, by using command like
git fetch; git checkout my-branch; git rebase -i origin/master. Clean up your commit message at this point. Be super careful to communicate with anybody else working on this branch, and do not do this when others have uncommitted changes. Ideally, your merge of your feature back to master should be one nice commit."🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...icate with anybody else working on this branch and do not do this when others have unc...(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/rails-webpacker-react-integration-options.md (2)
10-14: Table Formatting Consistency
The updated table header now includes an extra column placeholder ("---"). Please verify whether this additional column is intentional or if it results from a formatting oversight.
157-158: Babel Configuration Clarity for React Hot Loader
The documentation instructs to add the pluginreact-hot-loader/babelwith option"safetyNet": false. For improved clarity, consider inserting the article “the” before “option” (i.e. “with the option …”).🧰 Tools
🪛 LanguageTool
[uncategorized] ~157-~157: You might be missing the article “the” here.
Context: ...pluginreact-hot-loader/babelwith option"safetyNet": false: ``` { "plugi...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/contributor-info/linters.md (5)
10-11: Refine Rubocop instruction phrasing.The Rubocop instruction is now clearly set as a numbered list item. However, consider rephrasing "in the right directory" to something like "in the appropriate directory" to avoid repetitive wording (especially if similar language appears in the eslint instruction).
12-14: Add language specifier for the Rubocop command block.The fenced code block for the "rubocop -a" command enhances clarity, but specifying a language (for example, using
bash) can improve syntax highlighting and clarity for contributors reviewing the document.@@ -``` +```bash🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
12-12: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
18-20: Include language identifier in the ESLint command code block.Similar to the Rubocop command block, adding a language specifier (e.g.,
bash) will enable proper highlighting for the "eslint --fix ." command and maintain consistency across the documentation.@@ -``` +```bash🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
18-18: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
24-26: Enhance fenced code block for npm command with a language tag.Specifying a language (such as
bash) for the "npm run lint -- --fix" command block will aid contributors by providing correct syntax highlighting and further standardizing code examples in the document.@@ -``` +```bash🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
24-24: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
68-71: Verify and polish the Useful Reference Links list formatting.The updated bullet list for the reference links now benefits from improved alignment and clarity. Please double-check if any repeated wording (such as the frequent appearance of "ESLint") is intentional or if it might be refined for variety.
🧰 Tools
🪛 LanguageTool
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ... Useful Reference Links - Configuring ESLint - [ESLint quick start](http://untilfalse.com/esli...(ENGLISH_WORD_REPEAT_RULE)
docs/additional-details/recommended-project-structure.md (6)
47-47: Refine Styling Assets Query
The revised line asking, "Should you move your styling assets to Webpack? Or stick with the plain Rails asset pipeline. It depends!" introduces the topic in an engaging way. Consider reviewing the punctuation for enhanced clarity (for example, by merging the sentence or using a colon).
55-56: Punctuation Improvement in Rails Layouts Description
In the sentence "Your Rails layouts just doing the styling the standard Rails way," consider adding a comma or rephrasing for clarity. For example: "Your Rails layouts, which handle styling the standard way, ..."🧰 Tools
🪛 LanguageTool
[uncategorized] ~56-~56: Possible missing comma found.
Context: ...t get involved with styling. Your Rails layouts just doing the styling the standard Rai...(AI_HYDRA_LEO_MISSING_COMMA)
59-60: Grammatical Correction for Advantage List
In the bullet point "1. Much simpler! There's no changes really from your current processes," please correct the grammar. A suggested revision is: "Much simpler! There are no changes from your current processes."🧰 Tools
🪛 LanguageTool
[grammar] ~60-~60: Did you mean “There are no changes”?
Context: ... the Simple Rails Way 1. Much simpler! There's no changes really from your current processes. ##...(THERE_S_MANY)
64-64: Clarification on Webpack Customization Technique
The statement "This technique involves customization of the webpack config files to generate CSS, image, and font assets." is clear. If feasible, consider adding a brief example or a reference for further guidance on customizing the webpack configuration.
68-68: Punctuation Review for Asset Paths Section
In the asset paths description ("1./client/app/assets: Assets for CSS for client app... Note, most Sass and image assets will be stored next to the JavaScript files."), the punctuation after "Note" could be improved. Consider replacing the comma with a colon or restructuring the sentence for better clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ctory structure 1./client/app/assets: Assets for CSS for client app. 1. `/cli...(UNLIKELY_OPENING_PUNCTUATION)
73-73: Grammar Improvement in CSS Modules Description
The phrase "which is super compelling once you seen the benefits" would be clearer as "which is super compelling once you have seen the benefits." This minor change will improve readability and grammatical correctness.🧰 Tools
🪛 LanguageTool
[grammar] ~73-~73: A verb (‘be’ or ‘have’) is missing before the past participle.
Context: ...es), which is super compelling once you seen the benefits. 1. You can use CSS in JS....(PRP_PAST_PART)
docs/guides/render-functions-and-railscontext.md (6)
23-31: Refactored Component Declaration forMyAppComponentThe updated declaration now splits the component definition into two parts—a function taking
(props, railsContext)that returns an inner function component. This pattern enables the proper use of React hooks while clearly separating concerns. Please verify that all consumers ofMyAppComponenthave been updated to expect a higher-order function return value, and consider adding an inline comment explaining the rationale for future maintainers.
40-42: Formatting of Horizontal Rule and Grammar ImprovementThe horizontal rule at line 40 and the accompanying note at line 42 are now formatted consistently. The note uses italic styling for emphasis, which is good. However, according to the static analysis hint, consider revising the text by adding the article “an” so that:
- Change
to_This would be alternate API where you have to call React.createElement and the React on Rails code doesn't do that.__This would be an alternate API where you have to call React.createElement and the React on Rails code doesn't do that._This minor grammar improvement will enhance readability.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: You might be missing the article “an” here.
Context: ...yAppComponent; ``` --- _This would be alternate API where you have to call React.create...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
45-59: Alternate API Example UsingReact.createElementThe alternate API code block now shows a clear example of how to wrap the component in a function when using
React.createElement. The formatting of the nested arrow function and JSX has been improved for clarity. A couple of points to note:
- Verify that the trailing comma after
props(line 57) conforms to your project’s style guidelines.- Ensure that this API remains consistent with the primary example if both patterns are intended to coexist.
Overall, this snippet is clear and well formatted.
126-137: JSX Formatting in the HelloWorld ExampleIn the HelloWorld component example, the formatting adjustments (notably at line 132 and the trailing change at line 137) improve readability of the JSX structure. These changes ensure that the component’s layout is consistent with Prettier’s conventions.
144-152: Updated Declaration forAppComponentWithRailsContextThe revised declaration now returns an inner function component, following the same pattern as
MyAppComponent. This adjustment supports the use of React Hooks and ensures a consistent pattern across the examples. Verify that this pattern is uniformly adopted in the codebase and update any related documentation accordingly.
155-157: Clarity of JSX Spread Operator UsageThe JSX snippet that demonstrates spreading props and
railsContext(line 157) is formatted correctly. Although the double spread ({...{ ...props, railsContext }}) may appear slightly complex at first glance, it is a common and acceptable pattern. Consider adding a brief inline comment if you anticipate that future developers might need clarification on this usage.docs/outdated/rails-assets-relative-paths.md (5)
1-1: Consider Using a Proper Heading Syntax
The note at the very top currently uses italic emphasis. Using an actual heading (e.g., starting with##) could improve the document’s structural clarity.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1-1: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
50-51: Text Refinement in Explanation
Consider revising the sentence “both of these two example above do the exact same thing, just using different syntaxes” to something like “both of these examples do the same thing using different syntaxes” for grammatical correctness and conciseness.🧰 Tools
🪛 LanguageTool
[grammar] ~51-~51: After the number ‘two’, use a plural noun. Did you mean “examples”?
Context: ...name].[ext]', }, ``` both of these two example above do the exact same thing, just usi...(CD_NNU)
[style] ~51-~51: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ... both of these two example above do the exact same thing, just using different syntaxes. F...(EN_WORDINESS_PREMIUM_EXACT_SAME)
[uncategorized] ~51-~51: Possible missing comma found.
Context: ...ifferent syntaxes. For the rest of this doc we will be using the JSON object style....(AI_HYDRA_LEO_MISSING_COMMA)
53-53: Sentence Variation Suggestion
Multiple successive sentences in this section begin with the same word. Varying the sentence openings may improve flow and readability.🧰 Tools
🪛 LanguageTool
[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...k.github.io/docs/using-loaders.html). _For the sake of this doc, we're also going ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
61-61: Punctuation Improvement
Consider inserting a comma after “For now” to read “For now, we're just going to use:” which enhances readability.🧰 Tools
🪛 LanguageTool
[typographical] ~61-~61: Consider adding a comma here.
Context: ...r file's resulting name after bundling. For now we're just going to use: ```javascript...(FOR_NOW_COMMA)
67-67: Abbreviation Formatting
Ensure that abbreviations like “etc.” include the period at the end in accordance with American English conventions.🧰 Tools
🪛 LanguageTool
[style] ~67-~67: In American English, abbreviations like “etc.” require a period.
Context: ...nsion of the original file (.png, .jpg, etc). Next we'll set the outputPath for ou...(ETC_PERIOD)
docs/guides/file-system-based-automated-bundle-generation.md (2)
21-23: Enhanced clarity in the "Configure Components Subdirectory" section.The reformatting on lines 21–23 improves readability by clearly stating what
components_subdirectoryrepresents. Consider checking for consistent punctuation (e.g., a comma after “For example”) throughout the document.
163-178: Consider specifying a language for the fenced code block.The directory structure example now has improved formatting. Adding a language hint (e.g.
plaintextortext) for the fenced code block could further enhance readability in some editors by enabling appropriate syntax highlighting.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
163-163: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
docs/release-notes/15.0.0.md (3)
6-9: Enhance Clarity for React Server Components Section
The new section on React Server Components is clear and sets the stage for future RSC integration. Consider expanding the description with specific examples or benefits (such as performance improvements or integration details) to further guide users.
27-30: Updated Hydration Configuration Defaults
The changes to the default values fordefer_generated_component_packsandforce_loadare well explained. Consider a minor review of the phrasing—for instance, ensuring compound adjectives are appropriately hyphenated where needed—to enhance grammatical precision.🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...l hydrate early without waiting for the full page load. This improves performance by elim...(EN_COMPOUND_ADJECTIVE_INTERNAL)
34-34: Improve Clarity for Redux Store Support Sentence
The sentence regarding Redux store support is a bit cumbersome. Consider rewriting it for clarity and punctuation. For example:"The
force_loadoption for Redux store support now usesconfig.force_loadas its default value, which means that the Redux store will hydrate immediately as soon as its server-side data reaches the client. You can override this behavior by settingforce_load: falsein theredux_storehelper."This revision resolves the issue of connecting two independent clauses without a comma.
- - Redux store support `force_load` option now and it uses `config.force_load` value as the default value. Which means that the redux store will hydrate immediately as soon as its server-side data reaches the client. You can override this behavior for individual redux stores by setting `force_load: false` in the `redux_store` helper. + - The `force_load` option for Redux store support now uses `config.force_load` as its default value, which means that the Redux store will hydrate immediately as soon as its server-side data reaches the client. You can override this behavior by setting `force_load: false` in the `redux_store` helper.🧰 Tools
🪛 LanguageTool
[uncategorized] ~34-~34: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ce_loadconfiguration. - Redux store supportforce_loadoption now and it usesco...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~34-~34: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ux store supportforce_loadoption now and it usesconfig.force_loadvalue as th...(COMMA_COMPOUND_SENTENCE)
docs/rails/turbolinks.md (5)
4-7: Improved Section Header and PR Links Formatting
The updated bullet points in the "React on Rails Updated to support Turbo" section now present the PR references clearly. Consider rephrasing “gets obsolete” to “is becoming obsolete” for improved clarity.
38-41: Bullet List Re-formatting in "Why Not Turbolinks"
The list items are now more clearly delineated. Note that the numbering restarts (both items are marked as “1.”); while markdown auto-numbering will normalize this, you might consider explicit numbering for clarity.
43-47: Enhanced Details in "More Information" Section
The additional bullet details provide valuable context. However, the first bullet (regarding CSRF tokens) has several grammatical and punctuation issues:
- Consider inserting a comma before “however” and revising “I didn't look details however” to something like “I didn't look into the details; however, it may be app code related rather than library code.”
- Adding appropriate articles (e.g., “the” or “a”) would further improve clarity.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...he head element by JavaScript (not only body) on page changes with the correct csrf ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...ag, but if the JS code parsed this from head when several windows were opened, then ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~44-~44: Consider inserting a comma before ‘however’.
Context: ...ecs were not all passing. I didn't look details however, may be it is app code related, not libr...(HOWEVER_MISSING_COMMA)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ... is app code related, not library code. Anyway it may need additional check because th...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~44-~44: You might be missing the article “a” here.
Context: ... need additional check because there is CSRF helper in ReactOnRails and it need to w...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Tur...(COMMA_COMPOUND_SENTENCE)
[grammar] ~44-~44: The pronoun ‘it’ requires a third-person verb or a past tense.
Context: ...e is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Turbolinks5...(HE_NEED)
96-98: Clarification on ReactOnRails Re-initialization
The notice to callReactOnRails.reactOnRailsPageLoaded()in case components are not registered correctly is useful. A slight punctuation improvement—removing the comma after “experience”—could enhance readability.🧰 Tools
🪛 LanguageTool
[typographical] ~96-~96: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’.
Context: ...cripts asynchronously you may experience, that your Components are not registered corr...(COMMA_THAT_NOUN)
🪛 markdownlint-cli2 (0.17.2)
98-98: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
136-141: Turbolinks Classic Section Formatting
The presentation of the Turbolinks Classic messages is clear. For consistency, consider specifying a language for fenced code blocks if applicable.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
138-138: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (5)
21-21: Sentence continuation formatting:
The isolated “rendering.” on line 21 could be merged with the preceding sentence to improve flow. Consider combining it with the previous lines—for example, “...different webpack configuration for server rendering.”
47-48: Instruction clarity for HMR functionality:
The instruction “To enable HMR functionality you have to use./bin/shakapacker-dev-server” is concise and clear. A minor punctuation tweak (e.g., adding a comma after “Now”) could further improve its readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...n ## Basic installation To enable HMR functionality you have to use `./bin/shakapacker-dev-...(AI_HYDRA_LEO_MISSING_COMMA)
85-85: Grammar and clarity improvement:
Consider revising the sentence for smoother reading. For example:“We added the
overlay.sockPortoption inReactRefreshWebpackPluginto match the webpack dev-server port specified inconfig/shakapacker.yml. This ensures that sockjs functions properly and suppresses browser console errors such asGET http://localhost:[port]/sockjs-node/info?t=[xxxxxxxxxx] 404 (Not Found).”
This minor tweak would improve grammatical correctness and clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~85-~85: You might be missing the article “the” here.
Context: ... }), ); } ``` We addedoverlay.sockPortoption in `ReactRefres...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~85-~85: Possible missing comma found.
Context: ...ified inconfig/shakapacker.yml. That way we make sockjs works properly and suppr...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~85-~85: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...akapacker.yml`. That way we make sockjs works properly and suppress error in browser ...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
98-98: Minor grammatical suggestion:
Consider rephrasing “Now Browser should reflect...” to “Now, the browser should reflect...” to enhance clarity and grammatical correctness.
101-113: Enhanced list formatting for test configurations:
The bullet list detailing the environments and package versions is now clearer. For further consistency, you might standardize capitalization (e.g., “Babel” instead of “babel”) and punctuation throughout this list.KUDOS.md (3)
47-49: Refine Language in February 24, 2017 TestimonialThe testimonial for "February 24, 2017" is engaging; however, the phrase “so awesome and welcoming” may have benefit from a more formal adjective to better match the document’s tone. For example, consider an alternative like “incredibly supportive” or “exceptional” if that fits the intended sentiment. Also, note that “React” is correctly capitalized.
🧰 Tools
🪛 LanguageTool
[style] ~49-~49: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ators are great and the community is so awesome and welcoming. In fact, I love it so mu...(AWESOME)
[grammar] ~49-~49: “React” is a proper noun and needs to be capitalized.
Context: ...Rails](https://goo.gl/uzu36X) using the react_on_rails gem!" ) for improved readability in rendered views.
105-105: Reference URL Improvement for March 25, 2016The plain URL in the March 25, 2016 entry has been updated. For enhanced readability, consider converting it into a clickable markdown link.
docs/getting-started.md (1)
144-144: Compound Adjective Consistency
Consider hyphenating “server side entry file” to “server‑side entry file” to improve grammatical accuracy and clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~144-~144: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/misc/doctrine.md (4)
24-29: Improved Bullet List for "Convention over Configuration" Section
The reformatting into bullet points makes the section more scannable. As a nitpick, on line 27 the static analysis suggests reviewing the phrasing – if the intent was to refer to the noun “workout,” consider revising; otherwise, verify that “hard work” best expresses your meaning. Additionally, the phrase “splice it all together” might be reconsidered for clarity (the tool suggested “altogether” as an alternative).🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: Write this as one word if you mean the noun “workout”.
Context: ...on - React on Rails has taken the hard work out of figuring out the JavaScript tooling ...(WORK_COMPOUNDS)
[grammar] ~27-~27: Using the adverb ‘altogether’ may be more appropriate in this context.
Context: ...u'd have to figure out how to splice it all together. This is where a lot of "JavaScript fat...(ALTOGETHER)
55-56: Consider Hyphenating for Adjective Consistency in "No One Paradigm" Section
On line 55 the phrase “client side development” should be hyphenated to “client-side development” to align with standard compound adjective conventions.
57-59: Hyphenation Suggestion for "Exalt Beautiful Code" Section
In the sentence on line 58, “Client side code” would be clearer as “Client-side code” to maintain consistency with common adjective usage.🧰 Tools
🪛 LanguageTool
[uncategorized] ~59-~59: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... from the perspective that it rocks for client side development with Rails, even though it'...(EN_COMPOUND_ADJECTIVE_INTERNAL)
60-65: Refinement Suggestions for "Value Integrated Systems" Section
The reformatted section is much clearer. As a nitpick, consider:
– Revising “lots of business rules” to a more concise phrase like “numerous business rules.”
– Changing “pure client side app” to “pure client-side app.”
– Updating “React driven pages” to “React-driven pages” for a compound adjective.🧰 Tools
🪛 LanguageTool
[uncategorized] ~63-~63: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... ES6 is beautiful. React is beautiful. Client side code written with React plus Redux, ful...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/server-rendering-tips.md (2)
6-9: Nitpick: Consistent Compound Adjective Formatting
In the list item describing JS execution, consider changing "Server side JS execution" to "Server-side JS execution" for improved clarity and grammatical correctness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Your code can't referencedocument. Server side JS execution does not have access to `d...(EN_COMPOUND_ADJECTIVE_INTERNAL)
27-29: Typo & Punctuation Correction in Polyfill Note
There's a typographical error in "setTimout" which should be "setTimeout." Additionally, review the punctuation for smooth reading. For example, applying the following diff:-... did call setTimout. +... did call setTimeout.docs/guides/tutorial.md (2)
74-74: Minor Language Suggestion for Database Instruction
Consider adding an article for clarity. For example, "Note: You can use the--database=postgresqloption to use the PostgreSQL for the database."
367-370: Punctuation Enhancement in Cloud9 Example
For clarity, consider inserting a comma after "free Cloud9 IDE" so the sentence reads: "For example, to be able to run on free Cloud9 IDE, we are putting IP 0.0.0.0 and PORT 8080."🧰 Tools
🪛 LanguageTool
[uncategorized] ~368-~368: A comma might be missing here.
Context: ...ample, to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/guides/client-vs-server-rendering.md (1)
25-25: Compound Adjective Formatting Suggestion
Consider hyphenating "server side entry file" to "server-side entry file" to adhere to common compound adjective conventions.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/capistrano-deployment.md (2)
3-3: Grammar Enhancement: Add a Determiner for Clarity
Consider revising the sentence to:"Make sure ReactOnRails is working in the development environment."
This small change can improve readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: ...t Make sure ReactOnRails is working in development environment. Add the following to deve...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
5-5: Improve Instructional Clarity
The sentence "Add the following to development your Gemfile and bundle install." can be made clearer. Consider revising it to:"Add the following to your Gemfile in the development environment and run bundle install."
This clarifies the intended steps.docs/guides/webpack-configuration.md (2)
25-25: Typographical Correction: Remove Duplicate Article
There's a duplicate "the" in:"If you follow the steps in the the [basic tutorial]..."
Please remove one instance of "the" to correct the typo.🧰 Tools
🪛 LanguageTool
[duplication] ~25-~25: Possible typo: you repeated a word.
Context: ...n-and-code). If you follow the steps in the the [basic tutorial](https://www.shakacode....(ENGLISH_WORD_REPEAT_RULE)
[style] ~25-~25: Consider a shorter alternative to avoid wordiness.
Context: ...), you will see this pattern in action. In order to customize the Webpack configuration, yo...(IN_ORDER_TO_PREMIUM)
[style] ~25-~25: This phrase is redundant. Consider writing “consult”.
Context: ... the Webpack configuration, you need to consult with the [webpack configuration](https://www...(CONSULT_WITH)
41-43: Markdown Link Formatting Improvement
The bullet items list bare URLs. To avoid markdownlint MD034 warnings and improve accessibility, consider wrapping the URLs in proper markdown link syntax (e.g.,[link text](URL)).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
41-41: Bare URL used
null(MD034, no-bare-urls)
42-42: Bare URL used
null(MD034, no-bare-urls)
docs/javascript/react-router.md (1)
40-40: Compound Adjective Formatting
In the sentence "This example only applies to server rendering and should be only used in the server side bundle," consider hyphenating "server side" to "server-side" to clarify that it modifies "bundle."🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...dering** and should be only used in the server side bundle. From the [original example in ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/react-helmet.md (2)
27-27: Markdown Improvement: Avoid Bare URL Usage
The text "See https://github.com/nfl/react-helmet#server-usage." can be improved by wrapping the URL in markdown link syntax for better readability—for example:See React Helmet Server Usage for more details.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
27-27: Bare URL used
null(MD034, no-bare-urls)
91-92: Article Addition Suggestion
The phrase "it will return a hash instead of HTML string" could be made grammatically clearer by adding an article:"it will return a hash instead of an HTML string."
🧰 Tools
🪛 LanguageTool
[uncategorized] ~92-~92: You might be missing the article “an” here.
Context: ...gument it will return a hash instead of HTML string. Note, there is no need to speci...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
NEWS.md (10)
10-10: Grammar Correction Needed: Verb Form for "setup"
Consider replacing “for a new way to setup the creation…” with “for a new way to set up the creation…” to use the correct verb form.🧰 Tools
🪛 LanguageTool
[grammar] ~10-~10: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `r...(NOUN_VERB_CONFUSION)
17-17: Formatting Consistency for the Version 9.0.0 Entry
The entry is clear and follows the project’s style. Consider standardizing the casing (e.g. “VERSION” vs. “Version”) if consistency across entries is desired.
19-19: Suggestion: Consider Breaking Up Long Entry
This very long entry could benefit from additional line or paragraph breaks to further enhance readability.
20-20: Grammar Suggestion: Insert a Determiner
Rephrase “Only ‘breaking’ change is that you have to update both the node module and the Ruby gem” to “The only ‘breaking’ change is that you have to update both the node module and the Ruby gem” for improved clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ...rformance improvements! Please upgrade! Only "breaking" change is that you have to u...(AI_EN_LECTOR_MISSING_DETERMINER)
34-34: Potential Duplicate Entry Detected
This entry appears identical to the one on line 30. If these are meant to be distinct news items, consider differentiating them or removing the duplicate to avoid redundancy.
35-35: Duplicate Release Note for v6.1 – Please Review
This entry is a duplicate of the one on line 31. It might be worthwhile to remove or merge duplicate entries to enhance clarity.
45-45: Minor Grammar Suggestion for Subpoint Clarity
Consider revising “ability to render store data at bottom of HTML page” to “ability to render store data at the bottom of the HTML page” for improved clarity.
48-48: Clarity Suggestion for the Projects Page Entry
The phrase “Please edit the page your project” is ambiguous. Consider rephrasing to “Please edit the page for your project” or “submit your project details” for better clarity.
56-56: Typo Correction Needed: "lastest" Should Be "latest"
Please update “lastest version of Redux” to “latest version of Redux” to correct the typo.
60-60: Readability Enhancement for a Long Paragraph
This long entry detailing generator support for CSS modules can benefit from being broken into shorter sentences or paragraphs to improve clarity and readability.🧰 Tools
🪛 LanguageTool
[grammar] ~60-~60: “React” is a proper noun and needs to be capitalized.
Context: ...._ If you did generate a fresh app from react_on_rails and want to move to CSS Module...(A_GOOGLE)
[style] ~60-~60: Using many exclamation marks might seem excessive (in this case: 20 exclamation marks for a text that’s 8677 characters long)
Context: ...information. Ping us if you want to help! - ShakaCode...(EN_EXCESSIVE_EXCLAMATION)
spec/dummy/README.md (1)
3-4: Clarify Removal of Outdated Setup Instructions
The lines instructing to use'yalc link'and to install yarn dependencies inspec/dummy/clienthave been removed. Please verify that any steps once provided here are documented elsewhere so that new users are not confused by the missing setup details.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e spec/dummy/client/node_modules to the top level - Be sure to install yarn dependencies ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
CONTRIBUTING.md (2)
21-23: IDE Setup Instruction Punctuation
In the sentence "It's critical to configure your IDE/editor to ignore certain directories. Otherwise your IDE might slow to a crawl!", please consider adding a comma after "Otherwise" to improve readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...E/editor to ignore certain directories. Otherwise your IDE might slow to a crawl! - /cov...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
235-262: Linting and Docker Command Clarity
The linting instructions and Docker-related commands are now presented more clearly. As a minor suggestion, consider adding language identifiers (for example, using ````sh` instead of plain fenced code blocks) to adhere to markdown best practices.🧰 Tools
🪛 LanguageTool
[grammar] ~237-~237: The word ‘lint’ is a noun or an adjective. A verb or adverb is missing or misspelled here, or maybe a comma is missing.
Context: ...changes via the lint container. You can lint locally by running `npm run lint && npm...(PRP_MD_NN)
[grammar] ~242-~242: The word ‘install’ is not a noun.
Context: ...he initial build is slow, but after the install, startup is very quick. ### Linting Co...(A_INSTALL)
[style] ~242-~242: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...slow, but after the install, startup is very quick. ### Linting Commands Runrake lint...(EN_WEAK_ADJECTIVE)
[typographical] ~250-~250: Consider adding a comma here.
Context: ...rs. For individual rake linting commands please refer torake -D dockerfor the list....(PLEASE_COMMA)
spec/dummy/client/README.md (2)
16-18: Autofix Command Improvement
The command for autofixing (yarn run lint -- --fix) is now clearly indented. To further enhance the markdown, consider specifying the language (e.g.bashorsh) within the fenced code block.
19-25: Updated Node Dependencies Section
The "Updating Node Dependencies" section now presents its code block in a consistent manner. Again, adding a language identifier (such assh) to the fenced code blocks would improve markdown compliance.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
21-21: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
21-21: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
25-25: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
25-25: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
README.md (1)
39-44: Premium Content Bullet Point Review
One bullet point reads "How to conditionally render server side based on the device type". Consider rephrasing this (for example, "render on the server conditionally based on the device type") to avoid splitting the infinitive for improved clarity.docs/home.md (1)
18-24: Example Apps Section with Minor Verb Correction
The "Example Apps" section is now clearly delineated. As a minor language suggestion, consider revising "for a new way to setup the creation of your SSR bundle" to "for a new way to set up the creation of your SSR bundle" when using the verb form.🧰 Tools
🪛 LanguageTool
[grammar] ~22-~22: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `s...(NOUN_VERB_CONFUSION)
docs/additional-details/generator-details.md (2)
43-45: Refine Content Wording for Clarity
The added sentence on lines 43–45 can be improved by removing redundant phrases and adjusting punctuation for better clarity. For example, consider rephrasing to something like:
“The generated client code follows our organization scheme. Each unique set of functionality is allocated its own folder insideapp/javascript/app/bundles; for larger projects, we recommend usingclient/app/bundlesto better support modularity of domains.”
This aligns with the static analysis hints regarding redundant phrasing.🧰 Tools
🪛 LanguageTool
[style] ~44-~44: This phrase is redundant. Consider using “inside”.
Context: ... functionality, is given its own folder inside ofapp/javascript/app/bundles. Note, the...(OUTSIDE_OF)
[style] ~45-~45: This phrase is redundant. Consider using “Inside”.
Context: ...ncourages for modularity of domains. Inside of the generated "HelloWorld" domain you w...(OUTSIDE_OF)
48-50: Standardize List Item Phrasing and Punctuation
The changes to the list items (lines 48–50) would benefit from standardized punctuation and a more consistent tone. For instance:
- For the startup item, consider removing unnecessary words and splitting long sentences.
- For containers and components, aim for parallel structure.
A potential diff improvement:- - `startup`: This contains the entry point files for webpack. It defaults to a single file that is used for server and client compilation, but if these need to be different, then you can create two webpack configurations with separate endpoints. - - `containers`: "smart components" (components that have functionality and logic that is passed to child "dumb components"). - - `components`: includes "dumb components", or components that simply render their properties and call functions given to them as properties by a parent component. Ultimately, at least one of these dumb components will have a parent container component. + - `startup`: Contains the entry point files for webpack. It defaults to one file used for both server and client compilation; if different files are needed, you can create two separate webpack configurations. + - `containers`: Smart components that encapsulate functionality and pass logic to their child "dumb components". + - `components`: Dumb components that render provided properties and invoke functions passed by a parent component—typically nested within a container.This not only addresses the loose punctuation concerns flagged by static analysis but also enhances overall readability.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...find the following folders: -startup: This contains the entry point files for...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ... with separate endpoints. -containers: "smart components" (components that hav...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...child "dumb components"). -components: includes "dumb components", or componen...(UNLIKELY_OPENING_PUNCTUATION)
docs/guides/upgrading-react-on-rails.md (4)
36-37: Clarify i18n Output Configuration ChangesThe update regarding the i18n default format shifting to JSON is well described. As a nitpick, consider replacing “internalization” with “internationalization” for clarity.
69-70: Instruction Update for Component Render FunctionThe note asking developers to review
YourComponentRenderFunctionis brief and clear. It might be even more helpful to include a pointer to what exactly should be changed.
133-133: Grammar Suggestion for ConsistencyConsider changing “setup your Webpack configuration” to “set up your Webpack configuration” to align with standard verb usage.
🧰 Tools
🪛 LanguageTool
[grammar] ~133-~133: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...(https://github.com/rails/webpacker) to setup your Webpack configuration. ```yml def...(NOUN_VERB_CONFUSION)
269-275: Updated Webpack Configuration ExampleThe updated code snippet illustrates the required configuration changes effectively. As a nitpick, adding a language identifier (e.g.,
javascript) to the fenced code block can improve consistency.🧰 Tools
🪛 LanguageTool
[formatting] ~269-~269: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...name,** unless the bundle is server side.: ``` const webpackConfigLoader ...(DOUBLE_PUNCTUATION_PREMIUM)
🪛 markdownlint-cli2 (0.17.2)
271-271: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (87)
.github/ISSUE_TEMPLATE/bug_report.md(0 hunks).github/ISSUE_TEMPLATE/feature_request.md(0 hunks).github/PULL_REQUEST_TEMPLATE.md(1 hunks).prettierrc(1 hunks)CHANGELOG.md(19 hunks)CONTRIBUTING.md(11 hunks)KUDOS.md(1 hunks)NEWS.md(1 hunks)PROJECTS.md(1 hunks)README.md(4 hunks)SUMMARY.md(1 hunks)docs/additional-details/generator-details.md(1 hunks)docs/additional-details/manual-installation-overview.md(1 hunks)docs/additional-details/migrating-from-react-rails.md(1 hunks)docs/additional-details/recommended-project-structure.md(2 hunks)docs/additional-details/tips-for-usage-with-sp6.md(1 hunks)docs/additional-details/updating-dependencies.md(2 hunks)docs/api/javascript-api.md(2 hunks)docs/api/redux-store-api.md(4 hunks)docs/api/view-helpers-api.md(8 hunks)docs/contributor-info/generator-testing.md(1 hunks)docs/contributor-info/linters.md(2 hunks)docs/contributor-info/pull-requests.md(2 hunks)docs/contributor-info/releasing.md(1 hunks)docs/deployment/elastic-beanstalk.md(1 hunks)docs/deployment/heroku-deployment.md(1 hunks)docs/getting-started.md(7 hunks)docs/guides/client-vs-server-rendering.md(2 hunks)docs/guides/configuration.md(4 hunks)docs/guides/file-system-based-automated-bundle-generation.md(5 hunks)docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md(1 hunks)docs/guides/how-react-on-rails-works.md(2 hunks)docs/guides/how-to-use-different-files-for-client-and-server-rendering.md(3 hunks)docs/guides/i18n.md(1 hunks)docs/guides/installation-into-an-existing-rails-app.md(2 hunks)docs/guides/minitest-configuration.md(1 hunks)docs/guides/rails-webpacker-react-integration-options.md(7 hunks)docs/guides/react-on-rails-overview.md(1 hunks)docs/guides/react-server-rendering.md(2 hunks)docs/guides/render-functions-and-railscontext.md(6 hunks)docs/guides/rspec-configuration.md(4 hunks)docs/guides/streaming-server-rendering.md(4 hunks)docs/guides/tutorial.md(12 hunks)docs/guides/upgrading-react-on-rails.md(13 hunks)docs/guides/webpack-configuration.md(2 hunks)docs/home.md(2 hunks)docs/javascript/angular-js-integration-migration.md(2 hunks)docs/javascript/capistrano-deployment.md(1 hunks)docs/javascript/code-splitting.md(5 hunks)docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md(1 hunks)docs/javascript/credits.md(0 hunks)docs/javascript/foreman-issues.md(1 hunks)docs/javascript/images.md(0 hunks)docs/javascript/node-dependencies-and-npm.md(1 hunks)docs/javascript/react-and-redux.md(1 hunks)docs/javascript/react-helmet.md(6 hunks)docs/javascript/react-router.md(3 hunks)docs/javascript/server-rendering-tips.md(2 hunks)docs/javascript/troubleshooting-when-using-shakapacker.md(1 hunks)docs/javascript/troubleshooting-when-using-webpacker.md(1 hunks)docs/javascript/webpack-v1-notes.md(1 hunks)docs/javascript/webpack.md(2 hunks)docs/misc/articles.md(1 hunks)docs/misc/doctrine.md(2 hunks)docs/misc/style.md(1 hunks)docs/misc/tips.md(1 hunks)docs/outdated/deferred-rendering.md(2 hunks)docs/outdated/rails-assets-relative-paths.md(8 hunks)docs/outdated/rails-assets.md(2 hunks)docs/outdated/rails3.md(1 hunks)docs/rails/rails-engine-integration.md(2 hunks)docs/rails/rails_view_rendering_from_inline_javascript.md(2 hunks)docs/rails/turbolinks.md(3 hunks)docs/release-notes/15.0.0.md(3 hunks)docs/testimonials/resortpass.md(1 hunks)docs/testimonials/testimonials.md(1 hunks)knip.ts(1 hunks)lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.module.css(1 hunks)node_package/src/ClientSideRenderer.ts(10 hunks)package-scripts.yml(2 hunks)package.json(1 hunks)spec/dummy/README.md(2 hunks)spec/dummy/app/assets/stylesheets/application_non_webpack.scss(1 hunks)spec/dummy/client/README.md(3 hunks)spec/dummy/client/app/components/CssModulesImagesFontsExample.module.scss(2 hunks)spec/dummy/client/app/components/ImageExample/ImageExample.module.scss(1 hunks)spec/dummy/client/app/startup/RouterApp.server.jsx(1 hunks)
💤 Files with no reviewable changes (4)
- docs/javascript/images.md
- docs/javascript/credits.md
- .github/ISSUE_TEMPLATE/feature_request.md
- .github/ISSUE_TEMPLATE/bug_report.md
🚧 Files skipped from review as they are similar to previous changes (36)
- docs/testimonials/testimonials.md
- docs/additional-details/updating-dependencies.md
- docs/guides/react-on-rails-overview.md
- docs/deployment/heroku-deployment.md
- lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.module.css
- spec/dummy/client/app/startup/RouterApp.server.jsx
- spec/dummy/client/app/components/ImageExample/ImageExample.module.scss
- docs/guides/rspec-configuration.md
- docs/misc/articles.md
- docs/additional-details/migrating-from-react-rails.md
- docs/javascript/foreman-issues.md
- knip.ts
- docs/guides/configuration.md
- docs/javascript/node-dependencies-and-npm.md
- .github/PULL_REQUEST_TEMPLATE.md
- spec/dummy/app/assets/stylesheets/application_non_webpack.scss
- docs/guides/how-to-use-different-files-for-client-and-server-rendering.md
- docs/javascript/troubleshooting-when-using-shakapacker.md
- docs/javascript/react-and-redux.md
- docs/guides/minitest-configuration.md
- docs/outdated/deferred-rendering.md
- docs/guides/installation-into-an-existing-rails-app.md
- docs/guides/react-server-rendering.md
- .prettierrc
- package.json
- docs/guides/streaming-server-rendering.md
- node_package/src/ClientSideRenderer.ts
- docs/additional-details/tips-for-usage-with-sp6.md
- spec/dummy/client/app/components/CssModulesImagesFontsExample.module.scss
- docs/javascript/code-splitting.md
- docs/api/redux-store-api.md
- docs/rails/rails_view_rendering_from_inline_javascript.md
- CHANGELOG.md
- docs/contributor-info/releasing.md
- SUMMARY.md
- docs/api/javascript-api.md
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~22-~22: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...E/editor to ignore certain directories. Otherwise your IDE might slow to a crawl! - /cov...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~81-~81: Consider shortening or rephrasing this to strengthen your wording.
Context: ...eact-on-rails ``` The workflow is: 1. Make changes to the node package. 2. We need yalc to pu...
(MAKE_CHANGES)
[style] ~185-~185: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...figs, then you need to restart foreman. If you change the JS code for react-on-rai...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~205-~205: A comma might be missing here.
Context: .... ### Install Generator In your Rails app add this gem with a path to your fork. ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~237-~237: The word ‘lint’ is a noun or an adjective. A verb or adverb is missing or misspelled here, or maybe a comma is missing.
Context: ...changes via the lint container. You can lint locally by running `npm run lint && npm...
(PRP_MD_NN)
[grammar] ~242-~242: The word ‘install’ is not a noun.
Context: ...he initial build is slow, but after the install, startup is very quick. ### Linting Co...
(A_INSTALL)
[style] ~242-~242: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...slow, but after the install, startup is very quick. ### Linting Commands Run rake lint...
(EN_WEAK_ADJECTIVE)
KUDOS.md
[style] ~49-~49: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ators are great and the community is so awesome and welcoming. In fact, I love it so mu...
(AWESOME)
[grammar] ~49-~49: “React” is a proper noun and needs to be capitalized.
Context: ...Rails](https://goo.gl/uzu36X) using the react_on_rails gem!" ![The Complete React on ...
(A_GOOGLE)
[style] ~102-~102: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1997 characters long)
Context: ...ls gems to manage front end dependencies! React on Rails provides webpack integra...
(EN_EXCESSIVE_EXCLAMATION)
NEWS.md
[grammar] ~10-~10: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `r...
(NOUN_VERB_CONFUSION)
[uncategorized] ~12-~12: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v12**. 1. React Hooks Support for top level components 2. Typescript bindings...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ...rformance improvements! Please upgrade! Only "breaking" change is that you have to u...
(AI_EN_LECTOR_MISSING_DETERMINER)
[inconsistency] ~29-~29: Did you mean to refer to the current year? November 10, 2025 is not a Thursday, but a Monday.
Context: ...) - 2016-11-03: Spoke at [LA Ruby, 7pm, Thursday, November 10 in Venice, CA: "React on Rails: Why, Wh...
(EN_DATE_WEEKDAY_CURRENTYEAR)
[style] ~49-~49: Consider an alternative verb to strengthen your wording.
Context: ...md) for details, and let us know if you see any issues! [Migration steps from 1.x](...
(IF_YOU_HAVE_THIS_PROBLEM)
[grammar] ~60-~60: “React” is a proper noun and needs to be capitalized.
Context: ...._ If you did generate a fresh app from react_on_rails and want to move to CSS Module...
(A_GOOGLE)
[style] ~60-~60: Using many exclamation marks might seem excessive (in this case: 20 exclamation marks for a text that’s 8677 characters long)
Context: ...information. Ping us if you want to help! - ShakaCode...
(EN_EXCESSIVE_EXCLAMATION)
PROJECTS.md
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...You can confirm a project uses React on Rails as the source will contain **`js-react-...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...eals](https://www.redflagdeals.com/)**, Canadian shopping site. - **[YourMechanic](https...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~22-~22: You might be missing the article “a” here.
Context: ...](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. - **[HVMN...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~29-~29: This word is normally spelled as one.
Context: ...has gone live with React on Rails, with multi-lingual JavaScript support! ![2016-05-03_19-1...
(EN_COMPOUNDS_MULTI_LINGUAL)
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...lational Marketing for Real Estate. ## Open Source Projects Live - [github.com/empirical-...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ps://github.com/sharetribe/sharetribe): Open source marketplace platform.
(EN_COMPOUND_ADJECTIVE_INTERNAL)
README.md
[style] ~87-~87: Style-wise, it’s not ideal to insert an adverb (‘conditionally’) in the middle of an infinitive construction (‘to render’). Try moving the adverb to avoid split infinitives.
Context: ...lient-and-server-rendering/1352) - [How to conditionally render server side based on the device type](https://forum...
(SPLIT_INFINITIVE)
docs/additional-details/generator-details.md
[style] ~44-~44: This phrase is redundant. Consider using “inside”.
Context: ... functionality, is given its own folder inside of app/javascript/app/bundles. Note, the...
(OUTSIDE_OF)
[style] ~45-~45: This phrase is redundant. Consider using “Inside”.
Context: ...ncourages for modularity of domains. Inside of the generated "HelloWorld" domain you w...
(OUTSIDE_OF)
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...find the following folders: - startup: This contains the entry point files for...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ... with separate endpoints. - containers: "smart components" (components that hav...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...child "dumb components"). - components: includes "dumb components", or componen...
(UNLIKELY_OPENING_PUNCTUATION)
docs/additional-details/manual-installation-overview.md
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...eet_pack_tagandjavascript_pack_tag` helpers which is used to load the bundled asset...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...and javascript_pack_tag helpers which is used to load the bundled assets to your...
(AI_HYDRA_LEO_CPT_IS_ARE)
docs/additional-details/recommended-project-structure.md
[style] ~50-~50: Consider an alternative adjective to strengthen your wording.
Context: ...s asset pipeline. It depends! Here's a good discussion of this option: [Why does Ra...
(GOOD_CONSTRUCTIVE)
[uncategorized] ~56-~56: Possible missing comma found.
Context: ...t get involved with styling. Your Rails layouts just doing the styling the standard Rai...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~60-~60: Did you mean “There are no changes”?
Context: ... the Simple Rails Way 1. Much simpler! There's no changes really from your current processes. ##...
(THERE_S_MANY)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ctory structure 1. /client/app/assets: Assets for CSS for client app. 1. `/cli...
(UNLIKELY_OPENING_PUNCTUATION)
docs/api/view-helpers-api.md
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... you want to see the server side or the client side rails_context. Typically, for computing...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/contributor-info/generator-testing.md
[style] ~3-~3: This phrase is redundant. Consider writing “various” or “different”.
Context: ...act_on_rails/install_generator.rb) with various different options. We can then run tests with the...
(VARIOUS_DIFFERENT)
[uncategorized] ~9-~9: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... add that dependency to the main Gemfile or it will not work in CI. ## Configuring...
(COMMA_COMPOUND_SENTENCE)
docs/contributor-info/linters.md
[style] ~16-~16: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...` 3. eslint:: Be sure to be in the right directory where you have JS files. ```...
(REP_RIGHT)
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ... Useful Reference Links - Configuring ESLint - [ESLint quick start](http://untilfalse.com/esli...
(ENGLISH_WORD_REPEAT_RULE)
docs/contributor-info/pull-requests.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...# Checklist before Committing 1. rake: runs all linters and specs (you need Do...
(UNLIKELY_OPENING_PUNCTUATION)
docs/deployment/elastic-beanstalk.md
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...mpile. Also, it creates /home/webapp` directory allowing the precompile task to create ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~47-~47: “React” is a proper noun and needs to be capitalized.
Context: ...ic beanstalk successfully. However, the react app javascript files are under `public/...
(A_GOOGLE)
docs/getting-started.md
[uncategorized] ~144-~144: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/client-vs-server-rendering.md
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/file-system-based-automated-bundle-generation.md
[typographical] ~180-~180: After the expression ‘for example’ a comma is usually used.
Context: ...ry` nor directly add their bundles. For example you can have a Rails view using three c...
(COMMA_FOR_EXAMPLE)
[style] ~207-~207: Consider a shorter alternative to avoid wordiness.
Context: ...ge both in server and client rendering. In order to have separate definitions for client an...
(IN_ORDER_TO_PREMIUM)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...efresh). For use with webpack, see **Client Side rendering and HMR using react-refresh-w...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~17-~17: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...cker-dev-server` during development. # Server Side Rendering with the Default shakacode/sh...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~19-~19: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ... server-side rendering, then you have a couple options. The recommended technique is to have a...
(PLENTY_OF_NOUNS)
[uncategorized] ~43-~43: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...' of undefined" (if inline is true)` # Client Side rendering with HMR using react-refresh-...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~47-~47: Possible missing comma found.
Context: ...n ## Basic installation To enable HMR functionality you have to use `./bin/shakapacker-dev-...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~85-~85: You might be missing the article “the” here.
Context: ... }), ); } ``` We added overlay.sockPort option in `ReactRefres...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~85-~85: Possible missing comma found.
Context: ...ified in config/shakapacker.yml. That way we make sockjs works properly and suppr...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~85-~85: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...akapacker.yml`. That way we make sockjs works properly and suppress error in browser ...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~100-~100: A comma might be missing here.
Context: ...ding. If by some reason plugin doesn't work you could revert changes and left only ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~100-~100: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ... devServer hmr/inline to true affecting only css files. These plugins are working a...
(ADVERB_REPETITION_PREMIUM)
docs/guides/i18n.md
[grammar] ~29-~29: Normally, after “try to” a verb is expected.
Context: ...k process as well. Note: if you try to lint before running tests, and you depend on...
(WANT_TO_NN)
[uncategorized] ~33-~33: Possible missing comma found.
Context: ...he translations before running the lint command or 2. to run the tests first. 4. If...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/rails-webpacker-react-integration-options.md
[uncategorized] ~157-~157: You might be missing the article “the” here.
Context: ...plugin react-hot-loader/babel with option "safetyNet": false: ``` { "plugi...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/guides/render-functions-and-railscontext.md
[uncategorized] ~42-~42: You might be missing the article “an” here.
Context: ...yAppComponent; ``` --- _This would be alternate API where you have to call React.create...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/guides/tutorial.md
[uncategorized] ~75-~75: You might be missing the article “the” here.
Context: ...t-react-on-rails ``` Note: You can use --database=postgresql option to use Pos...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~368-~368: A comma might be missing here.
Context: ...ample, to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/guides/upgrading-react-on-rails.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nfiguration to a better setup ready for Server Side Rendering. ## Upgrading to v13 ### Br...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ion will be treated as a render function and it can return an Object rather than a R...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~133-~133: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...(https://github.com/rails/webpacker) to setup your Webpack configuration. ```yml def...
(NOUN_VERB_CONFUSION)
[uncategorized] ~144-~144: The preposition “by” seems more likely in this position.
Context: ..._RAILS"] usage. You can get all tracing with either specifying trace at your c...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~165-~165: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ndles to bypass the Rails asset pipeline and it's extra minification, enabling you t...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ... your client directory - .gitignore: add /public/webpack/* - Gemfile: bu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ... config/initializers/react_on_rails.rb: - Delete `config.generated_assets_dir...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~178-~178: The verb ‘Replace’ is plural. Did you mean: “replaces”? Did you use a verb instead of a noun?
Context: ...onfig now supplies this information - Replace `config.npm_build_(test|production)_com...
(PLURAL_VERB_AFTER_THIS)
[uncategorized] ~179-~179: A comma might be missing here.
Context: ...commend setting dev_server.hmr to false however since HMR is currently broken. - `clien...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~180-~180: Loose punctuation mark.
Context: ...urrently broken. - client/package.json: bump react_on_rails (I recommend bump...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~225-~225: This phrase is duplicated. You should probably use “Run Run” only once.
Context: ...rade RoR in the client/package.json - Run bundle - Run rails webpacker:install - Run rails webpacker:install:react - Run rails g react_on_rails:install - Move...
(PHRASE_REPETITION)
[style] ~242-~242: This phrase is redundant. Consider using “inside”.
Context: ...toconfig/initializers/react_on_rails.rbto keep your node_modules inside of/client 2. Renamed - config.npm_b...
(OUTSIDE_OF)
[formatting] ~269-~269: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...name,** unless the bundle is server side.: ``` const webpackConfigLoader ...
(DOUBLE_PUNCTUATION_PREMIUM)
[duplication] ~300-~300: Possible typo: you repeated a word.
Context: ...packer.yml - If you are not using the webpacker webpacker setup, be sure to put in `compile: fals...
(ENGLISH_WORD_REPEAT_RULE)
docs/guides/webpack-configuration.md
[uncategorized] ~27-~27: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s very little code needed to get started and you don't need to understand really any...
(COMMA_COMPOUND_SENTENCE)
docs/home.md
[grammar] ~22-~22: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `s...
(NOUN_VERB_CONFUSION)
docs/javascript/angular-js-integration-migration.md
[grammar] ~7-~7: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ave not already done this, then you can setup the ReactOnRails default JS code dire...
(NOUN_VERB_CONFUSION)
[style] ~7-~7: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style.
Context: ...inclusion this way will be no different than using the Rails asset pipeline. However...
(DIFFERENT_THAN)
[uncategorized] ~7-~7: “you” seems less likely than “you’re” (you are).
Context: ...ils asset pipeline. However, so long as you understand how your JavaScript will e...
(AI_HYDRA_LEO_CP_YOU_YOUARE)
docs/javascript/capistrano-deployment.md
[uncategorized] ~3-~3: You might be missing the article “the” here.
Context: ...t Make sure ReactOnRails is working in development environment. Add the following to deve...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/javascript/react-helmet.md
[style] ~10-~10: Consider a shorter alternative to avoid wordiness.
Context: ...## Example Here is what you need to do in order to configure your Rails application to wor...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~92-~92: You might be missing the article “an” here.
Context: ...gument it will return a hash instead of HTML string. Note, there is no need to speci...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[grammar] ~93-~93: Did you mean the proper noun or did you want to use it as a verb?
Context: ...rerender" as it would not make sense to use react_component_hash without server rendering...
(HAVE_TWITTER)
docs/javascript/react-router.md
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...dering** and should be only used in the server side bundle. From the [original example in ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/server-rendering-tips.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Your code can't reference document. Server side JS execution does not have access to `d...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...d call setTimout. Here's an example of this which shows the line numbers that end u...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/javascript/webpack-v1-notes.md
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1166 characters long)
Context: ...ment halt if Webpack cannot complete! For more details, see the documentation...
(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~7-~7: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Webpack returning a non-zero error code and you want to see all the errors, rather ...
(COMMA_COMPOUND_SENTENCE)
docs/javascript/webpack.md
[uncategorized] ~5-~5: You might be missing the article “an” here.
Context: ... "Code Splitting", etc You can try out example app, [shakacode/react-webpack-rails-tut...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
docs/misc/doctrine.md
[uncategorized] ~27-~27: Write this as one word if you mean the noun “workout”.
Context: ...on - React on Rails has taken the hard work out of figuring out the JavaScript tooling ...
(WORK_COMPOUNDS)
[grammar] ~27-~27: Using the adverb ‘altogether’ may be more appropriate in this context.
Context: ...u'd have to figure out how to splice it all together. This is where a lot of "JavaScript fat...
(ALTOGETHER)
[uncategorized] ~59-~59: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... from the perspective that it rocks for client side development with Rails, even though it'...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~63-~63: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... ES6 is beautiful. React is beautiful. Client side code written with React plus Redux, ful...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~67-~67: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...for Rails (document/database based with lots of business rules), the tight integration ...
(A_LOT_OF)
[uncategorized] ~67-~67: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on Rails is better than building a pure client side app and separate microservices. Here's ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~71-~71: The adjective “React-driven” is spelled with a hyphen.
Context: ...ws mixing and matching Rails pages with React driven pages, even on the same page. Not every...
(DRIVEN_HYPHEN)
[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p with: - Community suggestions. - New client side tooling, libraries, and techniques. - U...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/misc/style.md
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...n. - Anything additional goes next. ## Client Side JavaScript and React - See the [Shakac...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~39-~39: ‘off of’ might be wordy. Consider a shorter alternative.
Context: ...ow a github-flow model where you branch off of master for features. - Before merging a...
(EN_WORDINESS_PREMIUM_OFF_OF)
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...icate with anybody else working on this branch and do not do this when others have unc...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/misc/tips.md
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ht now is prerender: false. NOTE: Server side rendering does not work for some compon...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~11-~11: “React” is a proper noun and needs to be capitalized.
Context: ...nt. - Be sure you can first render your react component client only before you tr...
(A_GOOGLE)
docs/outdated/rails-assets-relative-paths.md
[grammar] ~51-~51: After the number ‘two’, use a plural noun. Did you mean “examples”?
Context: ...name].[ext]', }, ``` both of these two example above do the exact same thing, just usi...
(CD_NNU)
[style] ~51-~51: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ... both of these two example above do the exact same thing, just using different syntaxes. F...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
[uncategorized] ~51-~51: Possible missing comma found.
Context: ...ifferent syntaxes. For the rest of this doc we will be using the JSON object style....
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...k.github.io/docs/using-loaders.html). _For the sake of this doc, we're also going ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[typographical] ~61-~61: Consider adding a comma here.
Context: ...r file's resulting name after bundling. For now we're just going to use: ```javascript...
(FOR_NOW_COMMA)
[style] ~67-~67: In American English, abbreviations like “etc.” require a period.
Context: ...nsion of the original file (.png, .jpg, etc). Next we'll set the outputPath for ou...
(ETC_PERIOD)
docs/outdated/rails-assets.md
[uncategorized] ~8-~8: Did you mean: “By default,”?
Context: ...e other term for this is a "digest". > By default the filename of the resulting file is t...
(BY_DEFAULT_COMMA)
docs/outdated/rails3.md
[style] ~3-~3: Consider using a different verb to strengthen your wording.
Context: # Rails 3 - Please let us know if you find any issues with Rails 3. - Rails 3 is c...
(FIND_ENCOUNTER)
[style] ~5-~5: Consider using a different verb to strengthen your wording.
Context: ...not testing it for new releases. If you find an issue, you will have to submit a PR ...
(FIND_ENCOUNTER)
docs/rails/rails-engine-integration.md
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...ture: target destination option for the install generator #459](https://github.com/shak...
(A_INSTALL)
docs/rails/turbolinks.md
[typographical] ~11-~11: It seems that a comma is missing.
Context: ... obsolete. # Using Turbo To configure Turbo the following option can be set: `React...
(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~29-~29: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...reload JavaScript and stylesheets. This definitely can make an app perform better, even if the...
(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...he head element by JavaScript (not only body) on page changes with the correct csrf ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...ag, but if the JS code parsed this from head when several windows were opened, then ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~44-~44: Consider inserting a comma before ‘however’.
Context: ...ecs were not all passing. I didn't look details however, may be it is app code related, not libr...
(HOWEVER_MISSING_COMMA)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ... is app code related, not library code. Anyway it may need additional check because th...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~44-~44: You might be missing the article “a” here.
Context: ... need additional check because there is CSRF helper in ReactOnRails and it need to w...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Tur...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~44-~44: The pronoun ‘it’ requires a third-person verb or a past tense.
Context: ...e is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Turbolinks5...
(HE_NEED)
[uncategorized] ~81-~81: A comma might be missing here.
Context: ...start(); ``` ### async script loading Generally async script loading can be done like: ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~96-~96: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’.
Context: ...cripts asynchronously you may experience, that your Components are not registered corr...
(COMMA_THAT_NOUN)
docs/release-notes/15.0.0.md
[uncategorized] ~28-~28: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...l hydrate early without waiting for the full page load. This improves performance by elim...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ded. - The force_load configuration make react-on-rails hydrate components imm...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...hes the client, without waiting for the full page load. - If you want to keep the previ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...zers/react_on_rails.rbfile. - If we want to keep the original behavior offorce_lo...
(REP_WANT_TO_VB)
[uncategorized] ~34-~34: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ce_loadconfiguration. - Redux store supportforce_loadoption now and it usesco...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~34-~34: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ux store support force_load option now and it uses config.force_load value as th...
(COMMA_COMPOUND_SENTENCE)
docs/testimonials/resortpass.md
[style] ~3-~3: Consider an alternative adjective to strengthen your wording.
Context: ...ted code that both works and reflects a deep understanding of the technologies and p...
(DEEP_PROFOUND)
[grammar] ~3-~3: “React” is a proper noun and needs to be capitalized.
Context: ...s and standards for our transition to a react on rails application. Just three months...
(A_GOOGLE)
spec/dummy/README.md
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e spec/dummy/client/node_modules to the top level - Be sure to install yarn dependencies ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.17.2)
docs/contributor-info/linters.md
12-12: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
18-18: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
24-24: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/getting-started.md
140-140: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
docs/guides/file-system-based-automated-bundle-generation.md
163-163: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/guides/how-react-on-rails-works.md
5-5: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
5-5: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
docs/guides/upgrading-react-on-rails.md
64-64: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
143-143: Bare URL used
null
(MD034, no-bare-urls)
182-182: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
299-299: Bare URL used
null
(MD034, no-bare-urls)
303-303: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/guides/webpack-configuration.md
41-41: Bare URL used
null
(MD034, no-bare-urls)
42-42: Bare URL used
null
(MD034, no-bare-urls)
docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md
10-10: Bare URL used
null
(MD034, no-bare-urls)
docs/javascript/react-helmet.md
27-27: Bare URL used
null
(MD034, no-bare-urls)
docs/javascript/troubleshooting-when-using-webpacker.md
10-10: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/outdated/rails-assets-relative-paths.md
1-1: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
docs/rails/turbolinks.md
94-94: Bare URL used
null
(MD034, no-bare-urls)
98-98: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
138-138: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
spec/dummy/client/README.md
9-9: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
21-21: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
21-21: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
25-25: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
25-25: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: dummy-app-integration-tests (oldest)
- GitHub Check: dummy-app-integration-tests (newest)
- GitHub Check: rspec-package-tests (oldest)
- GitHub Check: examples (newest)
🔇 Additional comments (252)
docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md (1)
4-5: Formatting: Consistent Indentation Improvement.
The additional indentation on these lines improves the readability of the instructions by clearly separating the explanation from the numbered steps. Ensure that similar formatting is consistently applied across the document and any related documentation files.docs/outdated/rails3.md (1)
4-4: Ensure documentation consistency.
The statement "Rails 3 is confirmed to work up with versions up to 6.8.x." is clear; just ensure that future updates consistently reflect any changes in supported versions across similar documentation files.docs/rails/rails-engine-integration.md (3)
3-4: Clarify initializer instructionThe instruction clearly directs users to add the necessary code snippet at the top of
config/initializers/react_on_rails.rb. This added guidance is clear and well-placed.
11-12: Clear instruction for gemspec updateThe bullet point instructing changes in
<engine_name>.gemspecis straightforward. It helps ensure that users correctly add the dependency.
17-18: Added entry point instruction is informativeThe new instruction to update the engine’s entry point (
lib/<engine_name>.rb) by requiringreact_on_railsis clear and beneficial for users.docs/additional-details/manual-installation-overview.md (1)
3-5: Improved Readability by Removing Extra Blank LineThe removal of the extraneous blank line between the "TODO: Review this file" line and the subsequent descriptive line leads to a smoother visual flow and better overall readability.
package-scripts.yml (3)
4-4: Simplified Lint Command Execution
Thelint.scriptnow directly callsnps eslint, which simplifies the lint execution flow by removing the previously used concurrent handling. This change improves maintainability and reduces potential issues with output formatting and process management.
36-36: Unified Formatting Command
Updating to a single command (prettier --write .) for formatting all files helps enforce consistency across file types and aligns with the updated Prettier configuration. This approach reduces complexity compared to managing multiple concurrent commands.
39-39: Updated Format Check Command
Changing the format check command toprettier --check .replaces the older--list-differentoption, ensuring a more robust check that fits with the latest Prettier standards. This helps catch formatting issues effectively in the CI process.docs/javascript/webpack-v1-notes.md (1)
10-11: Formatting Enhancement: Improved Section SeparationThe insertion of a blank line before the "Entry Points" section (line 10) significantly improves the visual separation and overall readability of the document. This small change makes it easier for readers to distinguish between different sections.
🧰 Tools
🪛 LanguageTool
[style] ~11-~11: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...try points correctly for webpack if you want to break out libraries into a "vendor" bun...(REP_WANT_TO_VB)
[uncategorized] ~11-~11: Possible missing comma found.
Context: ... to break out libraries into a "vendor" bundle where your libraries are packaged separ...(AI_HYDRA_LEO_MISSING_COMMA)
docs/javascript/troubleshooting-when-using-webpacker.md (2)
9-10: Improved Readability with Added Blank LineThe insertion of a new blank line immediately after the "Rspec failing with" section enhances the visual separation between the section header and the subsequent error details, making the document easier to read.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
11-12: Concise Error Message FormattingThe removal of an extra blank line before the detailed error message (at line 12) results in a more compact display. This change helps to focus the reader’s attention on the error details without unnecessary spacing. Please verify that the tighter formatting still maintains clarity when viewed in different contexts.
docs/misc/tips.md (2)
3-8: Documentation Clarification: Revised Startup CommandThe updated instructions now advise using
foreman start -f Procfile.devto automatically start the webpack file watchers rather than runningrails s. This change improves clarity and aligns with the intended workflow for rebuilding JavaScript bundles when client code changes.
9-12: Content Update: Removal of Server-Side Rendering InstructionsThe detailed guidance regarding server-side rendering—including configuration defaults and component exposure—has been removed. Please confirm that this content removal is intentional and that related documentation or workflow references elsewhere are updated to reflect this change. Additionally, note that previous instances of "react" in the removed lines should have been capitalized as "React" for consistency, so ensure similar sections maintain proper styling if reintroduced in the future.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ht now isprerender: false. NOTE: Server side rendering does not work for some compon...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~11-~11: “React” is a proper noun and needs to be capitalized.
Context: ...nt. - Be sure you can first render your react component client only before you tr...(A_GOOGLE)
docs/guides/how-react-on-rails-works.md (1)
38-38: Enhanced Readability with Visual Separator
The newly introduced blank line before the numbered list (defining the custom build command) improves the visual separation and overall readability of the section. This is a positive formatting change.docs/javascript/angular-js-integration-migration.md (2)
9-11: Enhanced Readability with Added SpacingThe insertion of an extra blank line before the "Styling and CSS Modules" section improves the document’s visual structure and readability.
25-27: Improved Structuring for "Overall Approach?" SectionThe new blank line preceding the "Overall Approach?" section enhances the document’s organization and flow, making it easier to follow.
docs/outdated/rails-assets.md (1)
15-17: Maintain Consistent Spacing After HeadingsThe insertion of a new line after the "## The Problem" heading (line 16) improves visual separation and readability. No further changes are needed here, but please ensure similar spacing consistency across other documentation sections.
docs/javascript/webpack.md (5)
4-4: Formatting Enhancement: Inserted Blank Line for Readability
The new blank line after the "## Where do I learn about advanced Webpack setups..." heading improves visual separation from the following paragraph.
8-8: Formatting Enhancement: Added Spacing Below Section Heading
The inserted blank line after the "## Webpack v1 or v2?" heading creates a clear separation for better readability.
12-12: Formatting Enhancement: Consistent Spacing Under Headings
Adding a blank line after the "## yarn or npm?" heading aligns with the overall formatting improvements and enhances the document’s clarity.
21-22: Formatting Update: Revised List Items Layout
The reformatting of the bullet list under the "Entry Points" section improves consistency and visual structure, making the links easier to scan.
25-25: Formatting Enhancement: Extra Spacing for Section Clarity
The newly added blank line following the "## Webpack v4" heading helps delineate the section and improves the overall readability of the document.PROJECTS.md (2)
42-44: Verify Formatting in the Open Source Projects List
The open source projects list entries, including their links and descriptions, are well formatted. Ensure that the punctuation and phrasing remain consistent with the rest of the document.
47-51: Validate the Demos and Tutorials Section Formatting
The updated demos and tutorials section now clearly presents links and descriptions. The formatting appears consistent and clear; no additional changes are needed here.docs/guides/i18n.md (8)
7-10: Consistent Ruby Code Block for i18n_dir ConfigurationThe Ruby code block for setting
config.i18n_diris now clearly delimited with proper syntax highlighting. This improves readability and aligns with the Prettier formatting changes.
12-18: Uniform Formatting for i18n_yml_dir Code BlockThe updated code block for configuring
config.i18n_yml_diris well-formatted and consistent with the rest of the document. This maintains clarity for users following the guide.
24-27: Clearer Instructions for Startup Script AdjustmentsThe reformatting of the instruction regarding running
bundle exec rake react_on_rails:localebefore starting the webpack process helps clarify the recommended development workflow. The separation of the conditional regarding the React on Rails test helper further improves legibility.
37-39: Well-Formatted Ruby Code for Safe YAML LoadingThe code block defining
config.i18n_yml_safe_load_optionsis now clear and concise. The formatting adheres to the guidelines and helps prevent YAML-related issues through proper configuration.
44-47: Consistent Configuration for i18n Output FormatThe Ruby snippet for setting
config.i18n_output_format = "js"follows the updated formatting style, making it easy to read and apply.
51-58: Clear and Readable Dependencies SnippetThe JavaScript code block showing the dependency versions for
intlandreact-intlis now neatly formatted according to Prettier’s rules. This ensures users can quickly identify version requirements.
84-91: Consistent In-Component Code ExampleThe second JavaScript code block in this section is cleanly formatted and clearly demonstrates how to import and use
defaultMessages. No changes are needed.
93-97: Uniform Formatting in the Notes SectionThe Notes section now benefits from consistent spacing and punctuation. The links and list items are clearly presented, aiding readers in following the external resources.
docs/misc/style.md (6)
2-2: Enhanced Readability with Added Line Break
The new blank line after the "# Code Style" heading helps create visual separation, improving overall readability.
10-11: Clear Section Formatting for Client Side JavaScript and React
Adding a blank line before the bullet point and then listing "- See the Shakacode JavaScript Style Guide" enhances the overall structure and guides the reader’s attention effectively.
18-20: Well-Structured Ruby Coding Standards Section
The newly inserted bullet points providing links to the Ruby Coding Standards and documentation improve accessibility to these resources. The formatting is consistent with other sections, which is great for maintainability.
23-26: Enhanced Visibility for JavaScript Coding Standards
The bullet list now clearly directs readers to essential JavaScript resources and documentation, ensuring consistency with the overall style guide.
29-30: Accessible Git Coding Standards Information
The addition of the bullet point listing relevant Git coding standards makes the document more resourceful and easy to navigate.
41-41: Concise Mention of CI and Code Coverage
The bullet point added for running hosted CI and code coverage is succinct and clearly communicates the requirement.docs/guides/rails-webpacker-react-integration-options.md (6)
39-47: Standardize JSX Syntax and Consistent Quoting
The changes to theHellocomponent—adding parentheses around thepropsparameter and using double quotes consistently in JSX attributes—improve readability and consistency across the code sample.
127-144: Conditional Plugin Integration for React Refresh
The updates correctly condition the initialization ofReactRefreshWebpackPluginon the presence of theWEBPACK_DEV_SERVERenvironment variable. This approach ensures the plugin is only enabled during development. Please verify that the integration syntax remains compliant with future versions of the plugin.
151-154: React Hot Loader Installation Command
The shell command for installing bothreact-hot-loaderand@hot-loader/react-domis correctly formatted and follows best practices.
175-184: Hot Module Replacement in React Entry Point
Wrapping the exported component withhot()fromreact-hot-loader/root—as shown in the diff—effectively sets up the component for hot module reloading. This update is clear and adheres to standard HMR practices.
186-202: Sass Loader Source Map Optimization
The added conditional checking formodule.hotto setsourceMapContentsto false is a smart optimization. This conditional prevents unnecessary generation of source map contents during development when hot reloading is not active.🧰 Tools
🪛 LanguageTool
[uncategorized] ~186-~186: You might be missing the article “the” here.
Context: ...k configuration for development so thatsourceMapContentsoption for the sass ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
207-216: Webpack Environment Alias Update
Merging an alias for'react-dom'to point to@hot-loader/react-domensures compatibility with React Hot Loader. This change is well implemented and enhances the overall hot reloading configuration.docs/contributor-info/linters.md (1)
2-2: Improve spacing after the header.The insertion of an extra blank line after the "# Linters" header improves separation between the title and the content. This enhances readability and aligns well with markdown style guidelines.
docs/additional-details/recommended-project-structure.md (5)
18-18: New Section Header Added
The header "## Steps to convert from the generator defaults to use a/clientdirectory for source code" clearly signals the beginning of the migration instructions. This improves the document structure and user guidance.
28-29: Update Configuration for Custom Source Path
Changing the configuration snippet to usesource_path: clientcorrectly aligns with the new project structure. Please verify that this change is consistent with the rest of your Shakapacker configuration file.
36-37: Additional Step for Package Delegation
The new instruction "2. Create a/package.jsonthat delegates to/client/package.json" is a clear and helpful addition for projects adopting a custom webpack setup.
43-44: Clarification on Environment Variable Setup
The note to set the ENV value ofSHAKAPACKER_CONFIGto point to theconfig/shakapacker.ymlfile (and the mention of the spelling change from Webpacker to Shakapacker) is very useful. This additional guidance should help avoid confusion during configuration.
50-50: Reference Link for Styling Options
Including the discussion link on why Rails includes both Webpacker and Sprockets provides valuable context. Ensure that the link remains up to date with current discussions.🧰 Tools
🪛 LanguageTool
[style] ~50-~50: Consider an alternative adjective to strengthen your wording.
Context: ...s asset pipeline. It depends! Here's a good discussion of this option: [Why does Ra...(GOOD_CONSTRUCTIVE)
docs/guides/render-functions-and-railscontext.md (2)
61-63: Consistent Markdown Styling for NoticesThe horizontal rule and the subsequent italicized note (lines 61–63) reinforce the visual separation of content. The emphasis on potential React console warnings is clear.
116-116: Clear Demarcation for ERB ExampleThe introduction of the “ERB view file:” header at line 116 adds clarity by distinguishing the ERB snippet from other examples. This helps readers quickly identify context-specific code.
docs/outdated/rails-assets-relative-paths.md (11)
40-40: Consistent String Literal Formatting in Loader Configuration
The change to single quotes and the addition of a trailing comma on this line meet the new Prettier formatting guidelines.
47-48: JSON Object Formatting for Loader Query
Using single quotes for the property and adding a comma improves consistency with the new style settings.
56-56: Alias Configuration Update
The update to the'assets'alias (using single quotes) aligns with the formatting changes applied across the project.
64-64: Updated Name Property in File-Loader Configuration
The modification to use single quotes for the file name pattern is consistent with Prettier conventions and enhances code uniformity.
72-72: Output Path Formatting Consistency
The updatedoutputPathnow uses single quotes and a trailing comma, ensuring its formatting aligns with the rest of the configuration.
84-84: Public Path Configuration Update
The change to format thepublicPathwith single quotes and proper comma placement is correct and consistent.
136-136: Entry Point Array Formatting
The revised entry definition now follows Prettier guidelines, which improves the readability of the webpack configuration.
140-140: Webpack Output Path Update
The change to the output path in the webpack config has been correctly updated to reflect the new formatting standards.
156-157: Plugin Configuration Formatting
The revised structure for theDefinePlugin—including the adjusted line breaks and comma usage—improves clarity and adheres to the Prettier configuration changes.
174-174: Trailing Comma in Imports-Loader Configuration
Adding a trailing comma here not only conforms to the new formatting rules but also helps reduce future diff noise.
184-189: File-Loader Public Path Settings
The changes within this block—especially the consistent use of single quotes and the proper placement of commas—ensure that the file-loader configuration is consistent with the updated Prettier rules.docs/api/view-helpers-api.md (11)
2-3: Improved Header FormattingLines 2–3 now present the document’s main titles with a cleaner, more consistent markdown style. The refined heading levels and spacing help enhance overall readability.
7-7: Enhanced Section Separation with a Horizontal RuleThe horizontal rule introduced at line 7 provides a clear visual break between the introductory headers and the content that follows. This improves the document’s structure and navigability.
19-19: Refined Introduction for “Uncommonly used options”The formatting adjustment at line 19 enhances the presentation of the "Uncommonly used options" section, making the transition from the introductory text smoother.
42-42: Consistent Content DelimitationThe insertion of a horizontal rule at line 42 clearly demarcates the preceding section from the content that follows. This small but effective change aids readers in distinguishing between different topics.
81-81: Improved Visual SeparationA horizontal rule added at line 81 further segments the document, ensuring that distinct content blocks are visibly separated. This contributes positively to the document’s clarity and ease of reading.
84-84: Clarified Formatting for Cached Component SectionThe update at line 84 refines the introduction to the cached components section. The clearer formatting improves readability without altering the documented content.
95-95: Better Section SeparationThe horizontal rule inserted at line 95 reinforces the separation between content segments, contributing to a more organized and visually navigable document.
102-102: Clear Demarcation After Rails Context DescriptionThe horizontal rule added at line 102 effectively separates the rails_context explanation from subsequent sections. This change improves the logical flow of the documentation.
112-112: Improved Separation of Renderer Functions SectionThe addition of a horizontal rule at line 112 creates a clear boundary after the renderer functions description. This aids readers by markedly segmenting different discussion topics.
122-122: Enhanced Clarity for React Router SectionA horizontal rule introduced at line 122 cleanly ends the React Router discussion, helping to delineate content sections more clearly.
133-133: Final Section Separation ImprovementThe formatting change at line 133—adding a horizontal rule after the server_render_js section—improves the overall document structure, making it easier for readers to follow along.
docs/contributor-info/generator-testing.md (3)
2-2: Improved Readability with Added Blank Line
The inserted blank line after the "# Generator Testing" header increases visual clarity and separates the header from the subsequent content.
8-8: Enhanced Section Separation
The blank line inserted before the "Travis and Gemfiles" section helps distinguish sections and improves the document’s structure.
13-13: Clearer Instructions for Additional App Generation
The new sentence detailing how to specify additional apps to generate and test improves clarity.docs/contributor-info/pull-requests.md (4)
4-4: Improved Header-Content Separation in Checklist
The additional whitespace after the "## Checklist before Committing" header enhances readability by clearly delineating the header from the checklist items.
12-16: Enhanced Non-Doc Fixes Checklist Formatting
Reformatting the bullet points under "For non-doc fixes:" improves the overall clarity and scannability. The instructions remain clear and easy to follow.
22-23: Adjust Heading Level for Consistency
To maintain consistency in the document’s heading hierarchy, consider changing the heading from level four to level three. For example:-#### The seven rules of a great git commit message +### The seven rules of a great git commit messageThis change aligns with previous feedback on similar documents.
40-44: Consistent Documentation Reference Guidance
The revised bullet points for referencing documentation and source code files provide clear guidance. Ensuring that relative URLs work correctly for both GitHub and GitBook contexts contributes to a more robust documentation experience.docs/guides/file-system-based-automated-bundle-generation.md (10)
8-8: Improved spacing in the "Enable nested_entries for Shakapacker" section.The change on line 8 helps in visually demarcating the section. Ensure that similar spacing conventions are consistently applied throughout the document.
42-46: Refined bullet list formatting for generated files location.The adjustments in lines 42–46 provide a clearer, more structured description for the generated file locations. Please verify that the bullet list renders as expected in Markdown.
49-50: Clearer header spacing in the ".gitignore" update section.The revision in this section enhances readability by ensuring a consistent separation between the header and the body text.
58-65: Consistent formatting in the server bundle entrypoint section.Changes from lines 58 to 65 standardize the introductory text and the presentation of the code block (including the language specification for JavaScript), which improves clarity.
73-73: Formatting adjustment in the "Background" section.The change on line 73 creates better visual separation and enhances the overall flow.
154-159: Improved presentation of the layout code snippet.The updated formatting from lines 154 to 159 now clearly delineates the ERB snippet for
javascript_pack_tagandstylesheet_pack_tag. This makes the example easier to follow.
182-187: Consistent formatting in the Rails view code snippet.The ERB snippet that demonstrates the usage of auto-generated components now follows a clean and uniform presentation style.
189-201: Enhanced clarity for thereact_component_hashexample.The updated formatting of this multi-line ERB code block improves the readability of the rendered component example.
203-203: Improved explanation of theauto_load_bundleparameter.The revised text on line 203 clearly outlines how to set the default value via configuration, aiding in better comprehension by the reader.
211-211: Consistent formatting for annotation notes.The reformatting of the note on line 211 creates a consistent style with other annotated blocks in the document.
docs/release-notes/15.0.0.md (3)
15-17: Component and Store Hydration Description
The explanation of immediate hydration benefits for components and stores is straightforward and informative. No changes needed; the text clearly conveys the intended improvements.
36-48: Clear Representation of Async Function Change
The update forReactOnRails.reactOnRailsPageLoaded()is well conveyed with clear before-and-after examples. The instructions effectively communicate that callers must nowawaitthe function to handle the asynchronous behavior.
66-69: Clarify Store Dependency Behavior
The revised explanation of how component hydration now depends on the Redux store is clear. The text successfully highlights that components such asReduxAppandComponentWithNoStorewait onSimpleStore—a good clarification that will assist users in understanding the performance implications.docs/rails/turbolinks.md (14)
12-13: Inline Code Snippet for Turbo Option
The inline code snippetReactOnRails.setOptions({ turbo: true })is now clearly presented and easy to read.
20-24: Legacy Turbolinks Section Formatting
The "Legacy Turbolinks" section now clearly advises that the docs may be outdated and suggests updating to Turbo or removing old Turbolinks. The bullet list is well structured. Please verify that these recommendations still align with the current best practices.
27-27: Section Spacing Improvement for "Why Turbolinks?"
The additional spacing improves visual clarity in the section header.
33-33: Whitespace Adjustment in "Requirements for Using Turbolinks"
The minor spacing edit here enhances readability.
49-59: "Install Checklist" Formatting Improvement
The revised layout—including the fenced code block marked as ```erb—and separate note for Turbolinks 2.x enhances readability and consistency.
66-70: "Turbolinks 5" Section Spacing Enhancement
The updated spacing under the “Turbolinks 5” heading improves the document’s visual hierarchy.
75-78: "Turbolinks from NPM" Code Block Enhancement
The code snippet usingimport Turbolinks from 'turbolinks'; Turbolinks.start();is correctly formatted and clear.
80-93: Async Script Loading Instructions Update
The section on async script loading now clearly differentiates betweenasyncanddeferusage, and the updated code blocks help illustrate the approach. A minor suggestion is to rephrase “you will notice, that Turbolinks 5 does not fire” to “you will notice that Turbolinks 5 does not fire” for smoother reading.🧰 Tools
🪛 LanguageTool
[uncategorized] ~81-~81: A comma might be missing here.
Context: ...start(); ``` ### async script loading Generally async script loading can be done like: ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
105-105: "Troubleshooting" Section Header Spacing
The spacing adjustment for the "Troubleshooting" header improves separation from adjacent content.
109-113: ReactOnRails Options Code Block
The code snippet:ReactOnRails.setOptions({ traceTurbolinks: true, turbo: true, });is formatted neatly and is clear.
117-121: Define Constant for Development Build Check
The snippet definingconst devBuild = process.env.NODE_ENV !== 'production';is concise and clear.
123-131: Webpack DefinePlugin Option Update
The provided configuration forwebpack.DefinePluginis structured well and integrates clearly with the rest of the setup.
143-148: Turbolinks 5 Output Block Formatting
The formatting for the Turbolinks 5 output block is consistent and helps differentiate it from the Classic version.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
145-145: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
150-153: Final Advisory and Visual Elements
The closing recommendations and inclusion of the image are intact and help round out the document’s guidance.🧰 Tools
🪛 LanguageTool
[uncategorized] ~150-~150: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...y gem version of jQuery and jQuery ujs. Therefore we recommend using the node packages in...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (13)
9-11: Update deprecated hot-reloading messaging:
The revised text now clearly states that the older react-hot-loader is deprecated and points to fast-refresh for further details. This update improves clarity for developers switching to the new tool.🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...efresh). For use with webpack, see **Client Side rendering and HMR using react-refresh-w...(EN_COMPOUND_ADJECTIVE_INTERNAL)
13-14: Enhanced emphasis formatting for server-side rendering note:
The updated styling using not for emphasis in the phrase about server-side rendering improves readability and consistency across the document.
23-23: Improved section header formatting:
The new header “## If you use the same Webpack setup for your server and client bundles” now clearly delineates this section, enhancing document structure.
26-26: Clear configuration reference:
Highlighting theconfig/initializers/react_on_rails.rbsetting now makes it easier for developers to locate and adjust the necessary configuration.
35-35: Consistent mapping description:
The updated description fordev_server.inline(with its corresponding link) provides a clear mapping between the configuration property and the official webpack documentation.
40-41: Standardized bullet list for error messages:
The error messages are now presented in a consistent bullet list format, which enhances clarity for readers troubleshooting common issues.
44-45: Improved section demarcation:
The additional whitespace and the clear “## Basic installation” header improve the visual hierarchy and readability of the document.
49-49: Clear configuration directions:
The directive for setting hmr and inline in theconfig/shakapacker.ymlfile is now clearly stated and formatted, which aids in quick comprehension.
51-60: Enhanced dev_server configuration code block:
The re-formatted code block showing thedev_serverconfiguration now uses consistent indentation and spacing, thereby improving maintainability and ease of reading.
63-63: Improved command formatting:
The command for adding react refresh packages is now neatly formatted within inline code blocks, which makes it more prominent and easier to copy.
67-83: Optimized HMR plugin configuration code block:
The updated code block clearly outlines the HMR setup—importingdevServer, checking for theWEBPACK_DEV_SERVERenvironment variable, and appending the plugin with proper options. This refactor aids clarity and consistency in the configuration.
89-95: Consistent babel configuration formatting:
The babel configuration code block now uses clear formatting and proper indentation, making it straightforward to understand how the react-refresh plugin is conditionally added.
115-115: Final formatting adjustment:
The additional spacing at the end of the configuration section improves the overall appearance of the document.KUDOS.md (18)
14-14: Formatting Update on "June 9, 2017" HeadingThe heading for "June 9, 2017" has been updated to conform to the new Prettier formatting guidelines. Please verify that its style (e.g. spacing and punctuation) remains consistent with the other date headings in the timeline.
20-20: Consistent Heading for "May 6, 2017"The "### May 6, 2017" heading is now formatted in line with the updated style. It looks consistent with similar entries elsewhere.
26-26: Updated "April 6, 2017" HeadingThe heading for "April 6, 2017" reflects the new formatting adjustments. Ensure that its style (e.g. markdown level and spacing) matches the overall timeline design.
32-32: Revised "March 23, 2017" HeadingThe updated heading for "March 23, 2017" is now consistent with other date entries. Confirm that any downstream references (if used) are adjusted accordingly.
38-38: Updated Twitter AttributionThe line for Twitter attribution ("Twitter from @rfc2616") has been reformatted. Please ensure that the link and text styling meet the project’s documentation standards.
44-44: Image Markdown Consistency for March 2, 2017The updated image link (displaying the image for the "March 2, 2017" entry) appears to follow the new formatting rules. Verify that the image URL and alt text (if applicable) render correctly in previews.
53-53: Consistent Image Formatting for December 20, 2016The image markdown on line 53 has been updated. Please double-check that the image URL is valid and that the visual presentation is consistent with similar entries.
57-57: Image Update for December 12, 2016The updated image for the "December 12, 2016" entry now follows the new formatting guidelines. It should render correctly across different viewing contexts.
61-61: Revised Image Entry for November 15, 2016The image component for the November 15, 2016 entry has been reformatted. Confirm that the updated style integrates seamlessly with the rest of the document.
65-65: Consistent Update for November 9, 2016 ImageThe image markdown for the November 9, 2016 entry now adheres to the revised formatting rules. Please verify the preview to ensure it appears as expected.
74-74: Attribution Consistency for October 29, 2016The "by Email" attribution has been updated to the preferred style. Make sure this change is harmonized with other similar attributions in the file.
79-79: Image Update for September 11, 2016The image link for the September 11, 2016 entry has been reformatted. Please verify that the image displays correctly and the surrounding spacing is consistent.
83-83: Formatted Image for August 9, 2016The image markdown on line 83 now reflects the updated Prettier formatting. Confirm that the image URL and presentation are aligned with other timeline entries.
87-87: Updated Image Entry for June 15, 2016The image for the "June 15, 2016" entry has been reformatted. Please check that the image is rendering properly and that its size and alignment match expectations.
90-91: Reformatted Entry for May 11, 2016Both the heading ("### May 11, 2016") and its accompanying image have been updated. They now adhere to the Prettier formatting standards. Verify that this entry appears cohesive with the rest of the timeline.
97-97: Image Update for May 10, 2016The image markdown for the "May 10, 2016" entry has been reformatted. Ensure that the image loads correctly and that its margins and scaling are consistent.
101-101: Reformatted Heading for March 30, 2016The "### March 30, 2016" heading has been updated per the new formatting rules. Confirm that its style is consistent with all other date headings in the document.
108-108: Consolidated Reference for March 23, 2016 (Compared to Browserify)The supplementary reference ("See comments here") has been reformatted and included as part of the entry. Verify that the link is correct and that the additional context provided is useful.
docs/getting-started.md (8)
10-10: Enhanced Example Link
The updated list item now directs users to a full-featured example at github.com/shakacode/react-webpack-rails-tutorial, which improves clarity. Please verify that the link is current and that the example accurately reflects the intended usage.
53-53: Clarify Node Runtime Environment Note
The note explains that settingEXECJS_RUNTIME=Nodemay be required for your JS runtime. This is clear and helpful; just ensure it aligns with your deployment documentation for consistency.
72-74: Configuration Section Reordering
The configuration steps have been restructured to emphasize that most users only need to adjustconfig/shakapacker.yml. Please confirm that the removal or demotion ofconfig/initializers/react_on_rails.rbconfiguration details is intentional and does not confuse users who might need to customize defaults.
116-118: HTML Tag Formatting Improvement
Updating the line break to<br />ensures adherence to common HTML formatting standards and improves readability.
134-138: Component Registration Snippet Clarity
The updated snippet now includes the file path as a comment and clearly registersHelloWorldwith ReactOnRails. This improves context and clarity for users reading the code example.
171-171: Consistent Arrow Function Closure
The closing brace and semicolon for the arrow function are correctly formatted. No issues detected here.
194-195: Error Handling Section Formatting
The bullet points describing error handling are clear and informative. Ensure that this formatting style is consistent across the documentation.
199-200: I18n Note Clarity
The brief note on automatic conversion of Rails locale files is concise and clear. Please verify that the linked documentation for adding I18n is up-to-date.docs/misc/doctrine.md (7)
11-13: Enhanced Heading Readability for "Optimize for Programmer Happiness" Section
The introduction of a tilde-marked line after the heading improves visual separation and clarity. No content issues noted.
35-44: Consistent Formatting for "The Menu Is Omakase" and Libraries Section
The updated description and bullet list for libraries provides a clear, well-organized layout. No further changes are required here.
45-49: Clear and Organized "JavaScript Tooling" Section
The bullet list detailing Babel, ESLint, and Webpack is now easier to read and follows a consistent style.
52-52: Clarification Note on Omakase for Standard Rails
The inserted clarification (“By the way, we're not omakase for standard Rails…”) stands out well and aids reader comprehension.
67-73: Consistent Formatting in "Progress over Stability" Section
The bullet items in this section are now uniform and easy to follow. No modifications are needed.🧰 Tools
🪛 LanguageTool
[style] ~67-~67: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...for Rails (document/database based with lots of business rules), the tight integration ...(A_LOT_OF)
[uncategorized] ~67-~67: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...on Rails is better than building a pure client side app and separate microservices. Here's ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~71-~71: The adjective “React-driven” is spelled with a hyphen.
Context: ...ws mixing and matching Rails pages with React driven pages, even on the same page. Not every...(DRIVEN_HYPHEN)
74-76: Clear and Informative "Raise a Big Tent" Section
The updated text effectively communicates the benefits of integration with Webpack and NPM. The formatting is clear and engaging.
77-79: Polished Closing Note in "Thanks!" Section
The revised closing message is inviting and directs readers to provide feedback effectively.🧰 Tools
🪛 LanguageTool
[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p with: - Community suggestions. - New client side tooling, libraries, and techniques. - U...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/server-rendering-tips.md (1)
31-32: Formatting Confirmation for Code Example
The code example showing setTimeout usage is clear and well formatted.docs/guides/tutorial.md (2)
3-4: Improved Emphasis for Introductory Note
Changing the introductory note to italic using underscores enhances consistency with the project's markdown style.
7-8: Version Update Clarity
The updated note indicating support for Ruby 2.7, Rails 7, React on Rails v13, and Shakapacker v7 is clear and well formatted.docs/guides/client-vs-server-rendering.md (2)
3-4: Consistent Markdown Emphasis
The change from asterisk to underscore for italicizing the note maintains consistency with other documentation files.
1-28: Overall Documentation Formatting Improvement
The formatting adjustments in this guide improve readability and consistency without affecting the content's meaning.🧰 Tools
🪛 LanguageTool
[style] ~11-~11: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ance of your server rendering, then you want to use React on Rails Pro which uses NodeJ...(REP_WANT_TO_VB)
[uncategorized] ~11-~11: Possible missing comma found.
Context: ...ng, then you want to use React on Rails Pro which uses NodeJS to do the server rend...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~11-~11: The official spelling of this programming framework is “Node.js”.
Context: ...nt to use React on Rails Pro which uses NodeJS to do the server rendering. See the [do...(NODE_JS)
[uncategorized] ~17-~17: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...as server rendering errors. Note: these server side logs can be configured only to be sent ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~25-~25: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/capistrano-deployment.md (3)
7-11: Code Block Formatting Consistency
The Ruby code block now correctly starts with "```ruby" (without an extra space), which improves consistency and ensures that Prettier’s formatting rules are applied properly.
15-17: Shell Code Block Formatting Check
The shell code snippet using "```sh" is correctly formatted for improved readability.
21-23: Consistent Ruby Code Block Formatting
The code block displaying the Capfile snippet now adheres to the updated formatting style.docs/javascript/react-router.md (1)
10-11: Consistent Use of Semicolons in Imports
The import statements now include semicolons (e.g.,import { BrowserRouter, Switch } from 'react-router-dom'; ```) which aligns with common JavaScript style guidelines. </details> <details> <summary>NEWS.md (35)</summary> `3-3`: **Formatting Enhancement: Introductory Text Updated to Italics** The introductory sentence has been changed from bold to italics, which improves the visual emphasis and maintains consistency with the intended style. --- `5-6`: **Consistent Entry Formatting for October 14, 2020** The reformatting of the bullet entry (with bold date and linked content) improves readability and visual uniformity. --- `8-9`: **Improved Readability for October 1, 2020 Entry** Breaking the sentence into two lines clarifies the message by separating the description from the supporting detail. --- `16-16`: **Consistent Entry Formatting for Version 10.1.2** The entry for “2018-02-27: **Version 10.1.2** Supports the React API for ReactDOM.hydrate” uses the updated formatting style consistently with the other entries. --- `18-18`: **Clear Reminder to Check CHANGELOG** This reminder effectively directs readers to the CHANGELOG for more details. --- `21-21`: **Clear Notification of Beta Work** The note about the 8.0.0 beta work for including the webpacker_lite gem is clear and concise. --- `22-22`: **Entry for Version 6.9.3 is Clear** The format and message are concise and maintain the documentation style. --- `23-23`: **Simple Version Update Detailing Webpack v2** The update message is straightforward and adheres to the consistent formatting style. --- `24-24`: **Informative Internationalization Demo Notice** This entry clearly conveys information about the i18n demonstration and provides the necessary documentation link. --- `25-25`: **Clear Guidance on Webpacker Discussions** The entry is informative and maintains consistent formatting. --- `26-26`: **Actionable Upgrade Guidance** The advice on upgrading to Webpack v2 or using the `--bail` option is clearly communicated. --- `27-27`: **Well-Formatted Event Entry for LA Ruby (Basic Version)** This entry concisely provides details about the event without the additional time or day-of-week information. --- `28-28`: **Informative Entry for Egghead.io Video** The bullet entry clearly announces the new video and its link, and the formatting is on point. --- `29-29`: **Duplicate Date Consistency Issue – Please Verify** This entry mentions “2016-11-03” alongside “7pm, Thursday, November 10 …”, which appear inconsistent. Please verify the correct event date and corresponding day-of-week. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [inconsistency] ~29-~29: Did you mean to refer to the current year? November 10, 2025 is not a Thursday, but a Monday. Context: ...) - 2016-11-03: Spoke at [LA Ruby, 7pm, Thursday, November 10 in Venice, CA: "React on Rails: Why, Wh... (EN_DATE_WEEKDAY_CURRENTYEAR) </details> </details> --- `30-30`: **Documenting the New Gitbook Resource** This entry clearly informs users about the new Documentation Gitbook, improving resource accessibility. --- `31-31`: **Clear Release Note for Version 6.1** The entry effectively communicates the release note and directs users to the CHANGELOG for further details. --- `32-32`: **Server Rendering Recommendation is Well-Presented** The recommendation to use mini_racer for server rendering is clearly stated and provides a useful reference link for further details. --- `36-36`: **Essential Update Notification for Version 6.0.4** The entry effectively highlights the critical fix regarding the missing polyfill and maintains a clear and uniform format. --- `37-37`: **Critical Fix Notification for Version 6.0.2** The entry clearly conveys the importance of the update for fragment caching of the server-generated React. --- `38-38`: **Major Release Notification for Version 6.0.0** The entry is energetic and informative, clearly guiding users to refer to the CHANGELOG for more details. --- `39-39`: **Concise Release Note for Version 5.2.0** The information is presented in a clear and succinct manner, which is in line with the overall formatting improvements. --- `40-40`: **Slides Information Entry is Clear and Direct** The entry effectively directs users to additional resources via the provided link. --- `41-41`: **Informative Release Note for Version 4.0.3** The entry is clearly formatted and effectively provides context for the new Heroku buildpack steps. --- `42-42`: **Clear Release Note for Version 4.0.2** This line concisely communicates the release details, adhering to the updated formatting rules. --- `43-43`: **Enhanced Detail via Subpoint for Hot Reloading** The sub-bullet explaining improvements in hot reloading adds useful context and is well formatted. --- `44-44`: **Effective Communication of Turbolinks Support Enhancement** The sub-bullet clearly conveys the upgrade in Turbolinks support. --- `46-46`: **Helpful Reference Link Provided in Subpoint** The link to [#311](https://github.com/shakacode/react_on_rails/pull/311/files) is useful for readers seeking more details. --- `47-47`: **Breaking Changes Notification Subpoint is Clear** The sub-bullet effectively directs users to the CHANGELOG for detailed information on breaking changes. --- `49-49`: **Clear Migration and Release Note Information** This entry successfully conveys both the migration steps and the release details in a structured manner. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [style] ~49-~49: Consider an alternative verb to strengthen your wording. Context: ...md) for details, and let us know if you see any issues! [Migration steps from 1.x](... (IF_YOU_HAVE_THIS_PROBLEM) </details> </details> --- `50-50`: **Direct Reference to RubyGems** The provided link is clear and directly beneficial for users. --- `51-51`: **Direct Reference to NPM** This subpoint is consistent with the RubyGems reference and enhances user navigation. --- `52-52`: **Highlights Section Title for Version 3.0.0** The header “3.0.0 Highlights:” is succinct and clearly introduces the subsequent key points. --- `57-57`: **Highlights Section Title for 2.x Remains Consistent** This header clearly indicates the start of the highlights for the 2.x versions. --- `61-61`: **Informative Entry for ShakaCode Coaching** This entry clearly communicates the available coaching services and provides functional links. --- `62-62`: **Clear Call to Action to Read the Doctrine Article** This reminder effectively directs readers to further detailed content with proper formatting. </details> <details> <summary>spec/dummy/README.md (2)</summary> `25-25`: **Validate Updated Yarn Command** The command `yarn run dummy:install` is now clearly presented. It aligns with the updated formatting guidelines and appears correct. --- `39-46`: **Consistent Formatting for Asset Loading Sections** The formatting updates in the "Static Loading of Rails Assets" and "Creating Assets for Tests" sections make the instructions visually consistent. No functional changes were made. </details> <details> <summary>CONTRIBUTING.md (5)</summary> `3-5`: **Enhanced Contributor Links Section** The bullet list of contributor documentation links is now clearer and well organized. Please ensure the relative paths (e.g. `./docs/contributor-info/releasing.md`) resolve correctly in all cases. --- `8-11`: **Improved Test Setup Instructions** The added spacing and list formatting in the "To run tests:" section improve readability. The mention of the Yalc requirement for local development is clear. --- `24-34`: **Consistent Directory Ignore List** The bullet list of directories to ignore is now well formatted and easier to read. This change improves the overall clarity of the IDE/IDE setup section. --- `203-214`: **Clear Generator Installation Instructions** The instructions for adding the gem via a path and running `rails generate react_on_rails:install` are clearly outlined. These formatting improvements enhance the clarity of the generator installation process. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~205-~205: A comma might be missing here. Context: .... ### Install Generator In your Rails app add this gem with a path to your fork. ... (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA) </details> </details> --- `263-276`: **Final Sections Formatting Consistency** The final sections (including Docker CI details and maintainers’ advice) are consistently formatted and easier to follow. No functional changes were apparent. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [grammar] ~275-~275: If this is a question, the word order is probably incorrect. Did you mean “Why is this”… ? Context: ...ub.com/turbolinks/turbolinks) repo: > [Why this is not still fully merged?](https://github... (WHY_THE_WORD_ORDER_IS_WRONG) </details> </details> </details> <details> <summary>spec/dummy/client/README.md (3)</summary> `3-4`: **Updated ESLint Section Header** The header for "ESLint" has been updated to a single `#` header, which improves consistency with other files. The reference to Airbnb’s ESLint configuration remains intact. --- `9-11`: **Enhanced Running Linter Instructions** The "Running linter:" section is now more concise and clearly styled. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 9-9: Trailing punctuation in heading Punctuation: ':' (MD026, no-trailing-punctuation) </details> </details> --- `41-56`: **Adding Node Modules Section Clarity** The instructions under the "Adding Node Modules" section are now neatly organized. The conditional comment (`# or`) within the command section makes the options clear. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 50-50: Code block style Expected: indented; Actual: fenced (MD046, code-block-style) </details> </details> </details> <details> <summary>README.md (4)</summary> `1-12`: **Visual and Header Updates** The image and header sections retain their visual appeal, and the changes to the horizontal rule and badge placements are consistent with our style guidelines. --- `19-24`: **Updated News Section with New Bullet Points** The news bullet points now highlight relevant updates such as React 18 features, the maintenance of `shakapacker`, and support for Rails 7. The formatting is clear and helps communicate recent changes. --- `25-38`: **Improved Documentation Layout** The "About" section and subsequent blocks (e.g. "ShakaCode Upgrade Support") have been refined for clarity. These formatting adjustments enhance the overall reading experience without altering the core content. --- `45-155`: **Final Sections and Footer Formatting** The final sections—including "Contributing", "Work with Us", "License", and "Supporters"—are now uniformly formatted. These changes enhance the overall presentation and make the document easier to navigate. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [style] ~87-~87: Style-wise, it’s not ideal to insert an adverb (‘conditionally’) in the middle of an infinitive construction (‘to render’). Try moving the adverb to avoid split infinitives. Context: ...lient-and-server-rendering/1352) - [How to conditionally render server side based on the device type](https://forum... (SPLIT_INFINITIVE) </details> </details> </details> <details> <summary>docs/home.md (4)</summary> `1-4`: **Improved Documentation Structure** The main header (`# React on Rails`) and the "## Details" section now feature improved spacing, which enhances overall readability. --- `5-12`: **Clear and Concise Details Section** The bullet-list of guides in the "Details" section is clearly formatted and the links are easy to follow. --- `13-17`: **Enhanced Changes and Upgrades Section** The "Changes and Upgrades" section is straightforward and benefits from the improved spacing, making it easier to navigate. --- `25-28`: **Other Resources Section Clarity** The "Other Resources" section is succinct and its formatting allows for rapid comprehension of the available links. </details> <details> <summary>docs/additional-details/generator-details.md (1)</summary> `55-56`: **Header Formatting Looks Good** The Redux section header now stands out with improved spacing. No further action is required here. </details> <details> <summary>docs/guides/upgrading-react-on-rails.md (34)</summary> `4-4`: **Update Contact Information in "Need Help Migrating?" Section** The updated contact info and support details are clear and provide helpful guidance to users needing migration assistance. --- `11-12`: **Clarify Breaking Change for Upgrading to v13** The note about the previous use of the `webpacker` gem is clear. This change helps set the context for users migrating to v13. --- `24-26`: **Revise Upgrade v12 Section** The revised statements emphasize the importance of using recent versions of Rails and webpacker. The explicit mention of the [rails/webpacker] dependency is useful. --- `31-32`: **Update on Removed Configuration** The instruction to remove `config.symlink_non_digested_assets_regex` is clear and aligns with the deprecation. Consider double‑checking that all related documentation is updated. --- `52-57`: **Enhanced Code Example for Single-Parameter Function** The reformatted code snippet for functions that take zero or one parameter now reads much clearer. This example effectively shows how to return a React element. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 52-52: Heading levels should only increment by one level at a time Expected: h4; Actual: h5 (MD001, heading-increment) --- 52-52: Trailing punctuation in heading Punctuation: '.' (MD026, no-trailing-punctuation) </details> </details> --- `58-59`: **Detailed Explanation for Object Return in Render Functions** The additional context explaining why functions returning objects need adjustment is very instructive. The reference to the error message prepares users for potential issues. --- `72-75`: **Improved Code Block for Function Returning Object** The updated snippet clearly demonstrates the correct syntax when a function returns an object. The formatting improvements enhance readability. --- `77-78`: **Clarification on Function Parameter Requirement** The simple note that functions must have exactly two parameters is straightforward. This clarification will help prevent common mistakes. --- `80-83`: **Corrected Code Example for Two-Parameter Function** The code snippet now clearly shows the proper two-parameter signature. It is concise and easy to follow. --- `87-89`: **Enhanced Example for React Component Function Migration** The updated example demonstrates how to wrap a React element within a function correctly, addressing a common pitfall in migration. --- `103-106`: **Deprecation Example for Incorrect Two-Parameter Function** The corrected example of an incorrect approach (returning a JSX literal) is very illustrative. Adding a brief explanation of the underlying issue is a nice touch. --- `117-119`: **Corrected Pattern for Returning a React Component** This snippet now clearly presents the proper way to wrap a component for migration. The fixed structure minimizes confusion. --- `127-127`: **Formatting Adjustment** The updated horizontal rule effectively separates sections, improving visual clarity. --- `129-130`: **Updated Upgrade Instructions from rails/webpacker v3 to v4** The revised title and context set a clear stage for migration from webpacker v3 to v4. Ensuring this section aligns with the latest webpacker docs is recommended. --- `131-132`: **Revised Section for Custom Webpack Build File** The modifications in this section—especially regarding setting `extract_css`—are clear. The instructions help confirm that custom builds are appropriately configured. --- `135-139`: **Added YAML Example for Setting extract_css** The provided YAML snippet is well formatted (with the language identifier) and clearly demonstrates how to set `extract_css` to true. --- `142-146`: **Updated Instructions for Upgrading to Version 11** The removal instructions and guidance for React on Rails Pro are comprehensive. They clearly delineate which configurations are obsolete. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~144-~144: The preposition “by” seems more likely in this position. Context: ..._RAILS"] usage. You can get all tracing with either specifying **`trace`** at your c... (AI_EN_LECTOR_REPLACEMENT_PREPOSITION) </details> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 143-143: Bare URL used null (MD034, no-bare-urls) </details> </details> --- `149-152`: **Simplified Migration Steps for Version 10** The step-by-step migration guidance is concise and useful. The note about switching from `react_component` to `react_component_hash` is a good inclusion. --- `156-157`: **Updated Section Title on Why Webpacker** The revised heading is direct and sets the stage for explaining webpacker’s role. It meshes well with the surrounding content. --- `159-160`: **Enhanced Explanation of Webpacker's Advantages** The updated text effectively highlights benefits such as bypassing the asset pipeline and enabling source maps, which are important production considerations. --- `163-164`: **Updated Integration Section for Webpacker** The introductory remarks in this section are clear. A reference link for further details might be beneficial if available. --- `169-179`: **Updated Migration Steps for Keeping Your Client Directory** The expanded bullet-point list now covers all essential changes (e.g., updating `.gitignore`, Gemfile, layout views). *Note:* Consider reviewing punctuation consistency in these bullet points based on static analysis suggestions. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~171-~171: Loose punctuation mark. Context: ... your `client` directory - `.gitignore`: add `/public/webpack/*` - `Gemfile`: bu... (UNLIKELY_OPENING_PUNCTUATION) --- [uncategorized] ~176-~176: Loose punctuation mark. Context: ... `config/initializers/react_on_rails.rb`: - Delete `config.generated_assets_dir... (UNLIKELY_OPENING_PUNCTUATION) --- [grammar] ~178-~178: The verb ‘Replace’ is plural. Did you mean: “replaces”? Did you use a verb instead of a noun? Context: ...onfig now supplies this information - Replace `config.npm_build_(test|production)_com... (PLURAL_VERB_AFTER_THIS) --- [uncategorized] ~179-~179: A comma might be missing here. Context: ...commend setting dev_server.hmr to false however since HMR is currently broken. - `clien... (AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA) </details> </details> --- `180-182`: **Addition of Client Webpack Config Header** The new subheading “###### Client Webpack config:” clearly demarcates the beginning of the webpack configuration details. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [uncategorized] ~180-~180: Loose punctuation mark. Context: ...urrently broken. - `client/package.json`: bump `react_on_rails` (I recommend bump... (UNLIKELY_OPENING_PUNCTUATION) </details> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 182-182: Trailing punctuation in heading Punctuation: ':' (MD026, no-trailing-punctuation) </details> </details> --- `193-194`: **Clarification on Webpack Output Rules** The note explaining how the `output` variable is used within webpack’s configuration is clear and useful for developers. --- `215-216`: **Instructions for Loader Configuration Adjustments** The guidance for updating public paths for assets handled by `url-loader` and `file-loader` is precise. This change is crucial to avoid broken asset links. --- `241-244`: **Detailed Breaking Change Instructions** The updated list detailing changes (such as setting `config.node_modules_location` and renaming build commands) is clear and thorough. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [style] ~242-~242: This phrase is redundant. Consider using “inside”. Context: ...to`config/initializers/react_on_rails.rb`to keep your node_modules inside of`/client` 2. Renamed - config.npm_b... (OUTSIDE_OF) </details> </details> --- `254-264`: **Updated Property Renaming Guidelines for WebpackConfigLoader** The comprehensive list of property renames is well-structured. Please verify that these changes reflect the latest version of react-on-rails. --- `265-266`: **Instruction for Editing Webpack.config Files** The revised directives for updating your webpack configuration files are now clearer. This guidance should help avoid misconfiguration issues. --- `268-269`: **Enhanced Guidance on Output Filename Configuration** The emphasis on ensuring the webpack output includes a hash or chunkhash is well noted. This is critical for cache-busting in production. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [formatting] ~269-~269: These punctuation marks differ from each other. Use only one if you are ending a sentence. Context: ...name,** unless the bundle is server side.: ``` const webpackConfigLoader ... (DOUBLE_PUNCTUATION_PREMIUM) </details> </details> --- `286-286`: **Closing of Webpack Configuration Code Block** The proper closure of the code block ensures that the snippet is neatly encapsulated. --- `287-288`: **Updated Guidance for ManifestPlugin Configuration** The instructions on updating the ManifestPlugin setup are clear. Including a language identifier in the snippet might further improve clarity. --- `299-300`: **Renaming Instructions for webpacker_lite.yml** The updated instructions for renaming `webpacker_lite.yml` to `webpacker.yml` are straightforward. Also, ensure that no duplicate words are present as flagged by static analysis. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [duplication] ~300-~300: Possible typo: you repeated a word. Context: ...packer.yml - If you are not using the webpacker webpacker setup, be sure to put in `compile: fals... (ENGLISH_WORD_REPEAT_RULE) </details> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 299-299: Bare URL used null (MD034, no-bare-urls) </details> </details> --- `304-307`: **Updated Configuration for cache_manifest** The configuration snippet for production settings (using `cache_manifest`) is clear. Please verify that the snippet’s formatting remains consistent across markdown renderers. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 307-307: Fenced code blocks should have a language specified null (MD040, fenced-code-language) </details> </details> --- `329-334`: **Revised Instructions for Non-Webpacker Integration** The updated bullet points for scenarios when webpacker is not integrated are concise and actionable. This clear separation simplifies the decision-making process for users. </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
| - The `defer_generated_component_packs` and `force_load` configurations now default to `false` and `true` respectively. This means components will hydrate early without waiting for the full page load. This improves performance by eliminating unnecessary delays in hydration. | ||
|
|
||
| - The previous need for deferring scripts to prevent race conditions has been eliminated due to improved hydration handling. Making scripts not defer is critical to execute the hydration scripts early before the page is fully loaded. | ||
| - The `force_load` configuration make `react-on-rails` hydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Subject-Verb Agreement Correction
The sentence currently reads:
"The
force_loadconfiguration makereact-on-railshydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load."
For correct subject-verb agreement, "make" should be "makes."
- - The `force_load` configuration make `react-on-rails` hydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load.
+ - The `force_load` configuration makes `react-on-rails` hydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - The `force_load` configuration make `react-on-rails` hydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load. | |
| - The `force_load` configuration makes `react-on-rails` hydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ded. - The force_load configuration make react-on-rails hydrate components imm...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...hes the client, without waiting for the full page load. - If you want to keep the previ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/webpack-configuration.md
Outdated
| @@ -24,7 +24,7 @@ A key decision in your use React on Rails is whether you go with the Shakapacker | |||
|
|
|||
| Typical Shakapacker apps have a standard directory structure as documented [here](https://github.com/shakacode/shakapacker/blob/master/README.md#configuration-and-code). If you follow the steps in the the [basic tutorial](https://www.shakacode.com/react-on-rails/docs/guides/tutorial/), you will see this pattern in action. In order to customize the Webpack configuration, you need to consult with the [webpack configuration](https://www.shakacode.com/react-on-rails/docs/javascript/webpack/). | |||
|
|
|||
| The *advantage* of using Shakapacker to configure Webpack is that there is very little code needed to get started and you don't need to understand really anything about webpack customization. | |||
| The _advantage_ of using Shakapacker to configure Webpack is that there is very little code needed to get started and you don't need to understand really anything about webpack customization. | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve Clarity and Grammar in the Advantage Statement
The sentence:
"The advantage of using Shakapacker to configure Webpack is that there is very little code needed to get started and you don't need to understand really any about webpack customization."
can be revised for clarity and grammatical accuracy. For example:
-The _advantage_ of using Shakapacker to configure Webpack is that there is very little code needed to get started and you don't need to understand really any about webpack customization.
+The _advantage_ of using Shakapacker to configure Webpack is that very little code is needed to get started, and you don't need to understand anything about webpack customization.This change adds the missing element and improves punctuation.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The _advantage_ of using Shakapacker to configure Webpack is that there is very little code needed to get started and you don't need to understand really anything about webpack customization. | |
| The _advantage_ of using Shakapacker to configure Webpack is that very little code is needed to get started, and you don't need to understand anything about webpack customization. |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...s very little code needed to get started and you don't need to understand really any...
(COMMA_COMPOUND_SENTENCE)
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
from
4a495f3 to
de23424
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (111)
docs/testimonials/resortpass.md (1)
3-3: Improve Wording and Capitalization.
Consider replacing "deep understanding" with a more impactful adjective such as "profound understanding" to further enhance the testimonial’s tone. Additionally, ensure that "react on rails application" is updated to "React on Rails application" to correctly reflect the proper noun usage.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Consider an alternative adjective to strengthen your wording.
Context: ...ted code that both works and reflects a deep understanding of the technologies and p...(DEEP_PROFOUND)
[grammar] ~3-~3: “React” is a proper noun and needs to be capitalized.
Context: ...s and standards for our transition to a react on rails application. Just three months...(A_GOOGLE)
docs/contributor-info/generator-testing.md (1)
3-3: Nitpick: Remove Redundant DescriptorThe phrase “various different options” is redundant. Consider simplifying it to either “various options” or “different options” for clarity.
Suggested change:
- with various different options. + with various options.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: This phrase is redundant. Consider writing “various” or “different”.
Context: ...ct_on_rails/install_generator.rb)) with various different options. We can then run tests with the...(VARIOUS_DIFFERENT)
docs/deployment/elastic-beanstalk.md (2)
45-45: Add Comma for Enhanced ReadabilityThere's a potential missing comma after “assets:precompile” to clarify the sentence structure. This will improve readability.
-This script installs `yarn` and all `node.js` dependencies before the rails do `assets:precompile`. Also, it creates `/home/webapp` directory allowing the precompile task to create temp files. +This script installs `yarn` and all `node.js` dependencies before the rails do `assets:precompile`, and it creates `/home/webapp` directory allowing the precompile task to create temp files.🧰 Tools
🪛 LanguageTool
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...mpile. Also, it creates/home/webapp` directory allowing the precompile task to create ...(AI_HYDRA_LEO_MISSING_COMMA)
47-47: Capitalize “React” for Correct NamingThe static analysis tool suggests capitalizing “react” since it is a proper noun. Consider changing “react app javascript files” to “React app javascript files”.
-Your app can be deployed to elastic beanstalk successfully. However, the react app javascript files are under `public/packs`. If you are using nginx, you need to let it know the location of `https://yourhost/packs`. +Your app can be deployed to elastic beanstalk successfully. However, the React app javascript files are under `public/packs`. If you are using nginx, you need to let it know the location of `https://yourhost/packs`.🧰 Tools
🪛 LanguageTool
[grammar] ~47-~47: “React” is a proper noun and needs to be capitalized.
Context: ...ic beanstalk successfully. However, the react app javascript files are under `public/...(A_GOOGLE)
docs/javascript/foreman-issues.md (1)
11-13: Improve grammar and clarity in bullet point.
Consider revising the phrase"With `foreman 0.82.0` npm `react-s3-uploader` was failing to finish upload file to S3 when server was started by `foreman -f Procfile.dev`,"to something like:
"With `foreman 0.82.0`, npm `react-s3-uploader` was failing to finish uploading a file to S3 when the server was started by `foreman -f Procfile.dev`."This change corrects grammatical issues (adding "uploading a file" and "the server") and improves overall readability.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...ailing to finish upload file to S3 when server was started by `foreman -f Procfile.dev...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md (1)
10-10: Improve Bare URL FormattingThe bare URL on this line may trigger markdown linting rule MD034 ("no bare URLs"). Consider wrapping the URL in angle brackets or converting it into a Markdown link for enhanced readability and consistency across the documentation.
For example, you could update the line as follows:
- https://github.com/shakacode/shakapacker/tree/master/lib/install/bin + <https://github.com/shakacode/shakapacker/tree/master/lib/install/bin>🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Bare URL used
null(MD034, no-bare-urls)
docs/outdated/rails3.md (3)
3-3: Enhance the wording for improved clarity and impact.The sentence now reads:
- Please let us know if you find any issues with Rails 3.Consider revising it to something like:
- Please notify us if you encounter any issues with Rails 3.This revision uses a more active verb ("notify") for a stronger call to action.
🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Consider using a different verb to strengthen your wording.
Context: # Rails 3 - Please let us know if you find any issues with Rails 3. - Rails 3 is c...(FIND_ENCOUNTER)
4-4: Clarify the version compatibility phrasing.The current line:
- Rails 3 is confirmed to work up with versions up to 6.8.x.might benefit from a slight rewording for clarity. For example, you could change it to:
- Rails 3 is confirmed to work with versions up to 6.8.x.Confirm if "work up with" is intentional; if not, the suggested revision improves the statement's clarity.
5-5: Refine the instruction on submitting PRs.The current wording:
- We are not testing it for new releases. If you find an issue, you will have to submit a PR to get it fixed.can be enhanced for a more direct tone. For example, consider:
- We are not testing for new releases; if you encounter an issue, please submit a PR to help resolve it.This version provides a smoother flow and a clearer instruction to the reader.
🧰 Tools
🪛 LanguageTool
[style] ~5-~5: Consider using a different verb to strengthen your wording.
Context: ...not testing it for new releases. If you find an issue, you will have to submit a PR ...(FIND_ENCOUNTER)
docs/guides/how-react-on-rails-works.md (1)
5-5: Markdown Emphasis Style Change
The word "recommended" now uses underscores instead of asterisks. This change appears intentional per the updated formatting, but it conflicts with markdownlint’s MD049 rule which expects an asterisk style. If the underscore style is preferred, consider adding an override (for example, a markdownlint disable comment) to prevent false positives in automated linting.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
5-5: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
docs/javascript/webpack-v1-notes.md (1)
7-7: Style and Punctuation Enhancement for the Bail Option DescriptionThe updated sentence on line 7 now reads with an exclamation mark and a compound clause without a separating comma. Consider removing the exclamation mark for a more professional tone and inserting a comma before "and" to properly separate the independent clauses. This adjustment will improve the clarity and readability of the text.
Proposed diff:
-For your scripts that statically build your Webpack bundles, use the `--bail` option. This will ensure that CI and your product deployment **halt** if Webpack cannot complete! For more details, see the documentation for [Webpack's `--bail` option](https://webpack.js.org/configuration/other-options/#bail). Note, you might not want to use the `--bail` option if you just want to depend on Webpack returning a non-zero error code and you want to see all the errors, rather than only the first error. +For your scripts that statically build your Webpack bundles, use the `--bail` option. This will ensure that CI and your product deployment **halt** if Webpack cannot complete. For more details, see the documentation for [Webpack's `--bail` option](https://webpack.js.org/configuration/other-options/#bail). Note, you might not want to use the `--bail` option if you just want to depend on Webpack returning a non-zero error code, and you want to see all the errors, rather than only the first error.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1166 characters long)
Context: ...ment halt if Webpack cannot complete! For more details, see the documentation...(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~7-~7: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Webpack returning a non-zero error code and you want to see all the errors, rather ...(COMMA_COMPOUND_SENTENCE)
docs/javascript/webpack.md (1)
13-13: Minor Punctuation Suggestion
A static analysis hint flagged a potential missing comma. Consider revising line 13 for improved clarity:-You should ensure you configure the entry points correctly for webpack if you want to break out libraries into a "vendor" bundle where your libraries are packaged separately from your app's code. +You should ensure you configure the entry points correctly for webpack if you want to break out libraries into a "vendor" bundle, where your libraries are packaged separately from your app's code.This small change can enhance the readability of the sentence.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: Possible missing comma found.
Context: ... to break out libraries into a "vendor" bundle where your libraries are packaged separ...(AI_HYDRA_LEO_MISSING_COMMA)
docs/rails/rails-engine-integration.md (1)
35-38: Grammar Improvement for GitHub Issue Reference
The GitHub issues list is helpful in providing additional context. However, the text in the second bullet (line 36) uses “install generator,” where “install” is not typically used as a noun. Consider rephrasing it to “installation generator” to improve grammatical correctness and clarity. For example:- [Feature: target destination option for the install generator #459](https://github.com/shakacode/react_on_rails/issues/459) + [Feature: target destination option for the installation generator #459](https://github.com/shakacode/react_on_rails/issues/459)This minor change will enhance the readability and professionalism of the documentation.
🧰 Tools
🪛 LanguageTool
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...ture: target destination option for the install generator #459](https://github.com/shak...(A_INSTALL)
docs/misc/style.md (1)
38-42: Enhanced Clarity in Git Usage Guidelines with a Minor Punctuation Suggestion
The overall formatting improvements in the "Git Usage" section (lines 38–42) significantly improve readability. As a minor nitpick, on line 40 consider inserting a comma before "and do not do this when others have uncommitted changes" to further clarify the sentence. For example:-... communicate with anybody else working on this branch and do not do this when others have uncommitted changes. +... communicate with anybody else working on this branch, and do not do this when others have uncommitted changes.🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...icate with anybody else working on this branch and do not do this when others have unc...(AI_HYDRA_LEO_MISSING_COMMA)
docs/javascript/angular-js-integration-migration.md (1)
6-7: Suggestion: Refine phrasing in the "Assets Handling" section.
The changes improve formatting; however, consider replacing "setup" with "set up" to correctly use the verb form. Additionally, revising "no different than" to "no different from" will enhance clarity and adhere to standard style guidelines.Below is a suggested diff:
- if you have not already done this, then you can setup the `ReactOnRails` default JS code directory of `/client` + if you have not already done this, then you can set up the `ReactOnRails` default JS code directory of `/client`- so inclusion this way will be no different than using the Rails asset pipeline. + so inclusion this way will be no different from using the Rails asset pipeline.🧰 Tools
🪛 LanguageTool
[grammar] ~7-~7: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ave not already done this, then you can setup theReactOnRailsdefault JS code dire...(NOUN_VERB_CONFUSION)
[style] ~7-~7: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style.
Context: ...inclusion this way will be no different than using the Rails asset pipeline. However...(DIFFERENT_THAN)
docs/misc/tips.md (5)
3-7: Clarify the build instruction context.The new bullet instructs users not to run
rails sand to instead useforeman start -f Procfile.devto start webpack file watchers. Consider briefly noting why this approach is preferred (e.g., to ensure bundles are properly rebuilt before running tests), to help new developers understand the rationale behind the recommendation.
9-9: Use consistent compound adjective formatting.The phrase “Server side rendering” appears here. For clarity and consistency, consider hyphenating it as “server-side rendering” to align with standard usage when used as a compound adjective.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ht now isprerender: false. NOTE: Server side rendering does not work for some compon...(EN_COMPOUND_ADJECTIVE_INTERNAL)
10-10: Clarify React component exposure language.The instruction "rather than simply props" may be ambiguous. It might be clearer to rephrase it (e.g., "rather than directly using props") so that readers understand the difference in how a component is created via a function.
11-11: Correct capitalization and consider compound hyphenation.In "Be sure you can first render your react component client only...", "react" should be capitalized to "React" as it is a proper noun. Additionally, if “client only” is intended as a compound modifier, consider hyphenating it to "client-only" for improved clarity.
[grammar]🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: “React” is a proper noun and needs to be capitalized.
Context: ...nt. - Be sure you can first render your react component client only before you tr...(A_GOOGLE)
12-12: Enhance terminology consistency.The description in this bullet can benefit from consistent terminology. Consider revising "server rendered react components" to "server-side rendered React components" to match the recommended style and ensure clarity across the documentation.
docs/contributor-info/pull-requests.md (1)
12-16: Checklist Items Removal Verification
The checklist items under "For non-doc fixes:" (lines 12–16) have been removed. Please confirm that removing these guidelines is intentional and that it does not reduce the clarity of instructions for contributors.🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Possible missing article found.
Context: ...d entry? For non-doc fixes: - Provide changelog entry in the [unreleased section of the...(AI_HYDRA_LEO_MISSING_A)
docs/additional-details/generator-details.md (4)
44-44: Style Improvement: Replace "inside of" with "inside" for conciseness.The sentence on line 44 uses "inside of" which is less concise. Consider revising it to "inside" to improve clarity and adhere to a more streamlined style.
- Each unique set of functionality is given its own folder inside of `app/javascript/app/bundles`. + Each unique set of functionality is given its own folder inside `app/javascript/app/bundles`.🧰 Tools
🪛 LanguageTool
[style] ~44-~44: This phrase is redundant. Consider using “inside”.
Context: ...f functionality is given its own folder inside ofapp/javascript/app/bundles. This enco...(OUTSIDE_OF)
48-48: Punctuation & Clarity in List Item forstartup.The description for the
startupfolder can be made clearer by adjusting punctuation and sentence flow. Consider merging some sentences and adding appropriate punctuation (e.g., semicolons and commas) for readability.- `startup`: contains the entry point files for webpack. It defaults to a single file that is used for both server and client compilation. But if these need to be different, then you can create two Webpack configurations with separate endpoints. Since RoR v14.2 this is strongly recommended because the client can import `react-on-rails/client` instead of `react-on-rails` for decreased bundle size. + `startup`: contains the entry point files for webpack; it defaults to a single file used for both server and client compilation. If different files are needed, you can create two Webpack configurations with separate endpoints. Since RoR v14.2, this approach is strongly recommended because the client can import `react-on-rails/client` instead of `react-on-rails` for a decreased bundle size.🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...find the following folders: -startup: contains the entry point files for webp...(UNLIKELY_OPENING_PUNCTUATION)
49-49: Punctuation Cleanup forcontainers.The list item for
containerscontains extra punctuation that can be streamlined. Consider rephrasing slightly for improved readability.- `containers`: contains "smart components" (components that have functionality and logic that is passed to child "dumb components"). + `containers`: contains "smart components" (components with functionality and logic passed to child "dumb components").🧰 Tools
🪛 LanguageTool
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...or decreased bundle size. -containers: contains "smart components" (components...(UNLIKELY_OPENING_PUNCTUATION)
50-50: Refine the Description forcomponents.The description for
componentscould be tightened to improve clarity. For example, replacing "or components that simply render their properties and call functions given to them as properties by a parent component" with a more concise explanation will enhance readability.- `components`: contains "dumb components", or components that simply render their properties and call functions given to them as properties by a parent component. Ultimately, at least one of these dumb components will have a parent container component. + `components`: contains "dumb components", i.e., components that simply render their properties and invoke functions provided by a parent. Ultimately, at least one dumb component will have a parent container.🧰 Tools
🪛 LanguageTool
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...child "dumb components"). -components: contains "dumb components", or componen...(UNLIKELY_OPENING_PUNCTUATION)
docs/outdated/rails-assets.md (5)
3-3: Editorial Notice Formatting EnhancementThe italicized note "This doc needs updating for the use of Shakapacker or rails/webpacker with React on Rails" draws attention to the need for an update. Consider clarifying if this is a temporary placeholder or if a standardized alert/notice block would be more appropriate for future readers. Also, review if using emphasis here is the best way to signal this information, since markdown guidelines recommend headings or dedicated callout blocks in documentation.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3-3: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
8-9: Punctuation Improvement in BlockquoteThe blockquote starting on line 8 ("By default the filename ...") would read more naturally with a comma after "By default". For example:
> By default, the filename of the resulting file is the MD5 hash of the file's contents with
This small punctuation change improves readability as indicated by the LanguageTool hint.🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: Did you mean: “By default,”?
Context: ...e other term for this is a "digest". > By default the filename of the resulting file is t...(BY_DEFAULT_COMMA)
15-16: Spacing Adjustment in "The Problem" SectionA new line marker (line 16) appears to have been introduced after the "## The Problem" heading. Ensure that this additional space aligns with your formatting objectives and enhances readability without being excessive.
36-37: Consistent Spacing Before Section ContentAt line 37, an extra newline is inserted following the "## The Solution: Symlink Original File Names to New File Names" heading. Verify that this spacing is intentional to provide a visual break. If not, consider removing it for consistency with other sections.
38-39: Clarify the Symlink Solution NoteThe note reads:
"Note, this solution was removed in v14. If you're interested in this symlink solution, please create
a github issue."
For clarity and consistent tone, consider rephrasing to:
"Note: This symlink solution was removed in v14. If you are interested in revisiting this approach, please create a GitHub issue."
This change improves readability and aligns with standard documentation style.docs/guides/webpack-configuration.md (1)
41-42: Format Bare URLs to Comply with Markdown Linting StandardsThe URLs are currently presented as bare links, which may trigger markdown lint warnings (MD034). To improve the document’s adherence to markdown style guidelines and make the links more user friendly, consider converting them into proper markdown links. For example:
- https://github.com/shakacode/shakapacker/blob/master/package/environments/base.js + [Base JS](https://github.com/shakacode/shakapacker/blob/master/package/environments/base.js)- https://github.com/shakacode/shakapacker/blob/master/package/environments/development.js + [Development JS](https://github.com/shakacode/shakapacker/blob/master/package/environments/development.js)This adjustment will resolve the static analysis hints while enhancing clarity.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
41-41: Bare URL used
null(MD034, no-bare-urls)
42-42: Bare URL used
null(MD034, no-bare-urls)
docs/javascript/capistrano-deployment.md (3)
5-6: Clarify Gemfile Instruction
The instruction "Add the following to development your Gemfile and bundle install." is a bit unclear. Consider rephrasing it to something like:
"Add the following to your Gemfile in the development group and run bundle install."
This will make the procedure more understandable for readers.
15-17: Shell Command Prompt Formatting
The shell code snippet includes a leading "$", which is common for representing a command prompt. If this is intentionally meant to show the terminal prompt, it’s acceptable; otherwise, consider removing it if you only want to display the command itself.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
16-16: Dollar signs used before commands without showing output
null(MD014, commands-show-output)
25-25: Punctuation for Enhanced Readability
To improve the readability of the sentence, consider inserting a comma after "memory":
"Webpack consumes a lot of memory, so if possible, try increasing the RAM of your server."
This small change can improve the flow of the explanation.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: A comma might be missing here.
Context: ...se of memory. Webpack consumes a lot of memory so if possible, try increasing the RAM ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/api/view-helpers-api.md (1)
99-102: Nitpick – Compound Adjective Hyphenation:
Consider hyphenating compound adjectives (e.g., "server-side" and "client-side") when they appear before a noun, such as in "server-side rendering" or "client-side rails_context". This change adheres to common technical writing conventions and can improve clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... you want to see the server side or the client side rails_context. Typically, for computing...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/render-functions-and-railscontext.md (2)
40-42: Grammatical Suggestion for Alternate API Note:
The note currently reads:
"This would be alternate API where you have to call React.createElement and the React on Rails code doesn't do that."
Consider revising it to “an alternate API” for improved grammatical correctness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~42-~42: You might be missing the article “an” here.
Context: ...yAppComponent; ``` --- _This would be alternate API where you have to call React.create...(AI_EN_LECTOR_MISSING_DETERMINER_AN)
63-63: Punctuation Suggestion:
In the note regarding server rendering (line 63), consider adding a comma after “serverRender” to improve readability (e.g., “if you try to serverRender, this…”).🧰 Tools
🪛 LanguageTool
[uncategorized] ~63-~63: Possible missing comma found.
Context: ...sole warning if you try to serverRender this since the value ofserverSidewill be...(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/how-to-use-different-files-for-client-and-server-rendering.md (3)
6-6: Formatting clarity for entry points section
The updated line adds a clear explanation about the requirement for a top-level entry point. Consider reviewing the punctuation for enhanced clarity (e.g., adding a comma after "client and server rendering") if it improves the flow.
95-95: Consider safer window check in conditional example
The example usesif (window) {to determine if the code is running on the client side. In practice, directly referencingwindowmay throw a ReferenceError in non-browser (Node.js) environments. Consider usingif (typeof window !== 'undefined') {to safely check for the existence of the window object.
96-96: Clarification on server-side behavior of window object
The updated comment “// window should be falsy on the server side” reinforces that the window object is unavailable during server-side rendering. Expanding the explanation or recommending the safer check could further benefit readers who might adapt this code for production.docs/javascript/server-rendering-tips.md (2)
6-11: Cosmetic Formatting in "General Tips" Section
The whitespace adjustments before the bullet points enhance readability. Additionally, on line 7 consider hyphenating "server-side" when used as a compound adjective (i.e. "server-side JS execution") for consistency and clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Your code can't referencedocument. Server side JS execution does not have access to `d...(EN_COMPOUND_ADJECTIVE_INTERNAL)
26-29: Timer Methods Section – Formatting and Typo Check
The reflow and spacing updates in this section make the content clearer. However, note a potential typo on line 28: "setTimout" appears instead of the correct "setTimeout". Please verify and correct if required.docs/additional-details/manual-installation-overview.md (1)
21-22: Enhance Grammar and Punctuation in the Gem Installation InstructionThe updated lines for the Rails steps now read the gem installation instruction. Based on the static analysis hints, please consider the following improvements:
- Add a conjunction (“and”) to connect clauses after “to the Gemfile,” for smoother readability.
- Insert a comma before the relative clause.
- Change “is used” to “are used” to correct the subject–verb agreement.
Below is a suggested diff for the modified line:
-1. Add `gem "webpacker"` to the Gemfile, run bundle. The gem provides the `stylesheet_pack_tag` and `javascript_pack_tag` helpers which is used to load the bundled assets to your layouts.[Dummy Example](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/app/views/layouts/application.html.erb) +1. Add `gem "webpacker"` to the Gemfile, and run bundle. The gem provides the `stylesheet_pack_tag` and `javascript_pack_tag` helpers, which are used to load the bundled assets into your layouts.[Dummy Example](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/app/views/layouts/application.html.erb)🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...eet_pack_tagandjavascript_pack_tag` helpers which is used to load the bundled asset...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...andjavascript_pack_taghelpers which is used to load the bundled assets to your...(AI_HYDRA_LEO_CPT_IS_ARE)
docs/guides/i18n.md (3)
29-35: Reformatted Admonition Note for Linting Dependency
The note block now uses the[!NOTE]admonition style correctly. The guidance is clear; however, as a nitpick, consider rephrasing the list for enhanced clarity. For example, capitalizing the list items and adding appropriate punctuation might improve the tone. Here’s a suggestion:- > 1. run the rake task to build the translations before running the lint command or - > 2. to run the tests first. + > 1. Run the rake task to build the translations before running the lint command, or + > 2. Run the tests first.🧰 Tools
🪛 LanguageTool
[grammar] ~30-~30: Normally, after “try to” a verb is expected.
Context: ... as well. > [!NOTE] > If you try to lint before running tests, and you depend on...(WANT_TO_NN)
[uncategorized] ~34-~34: Possible missing comma found.
Context: ...he translations before running the lint command or > 2. to run the tests first. 4. ...(AI_HYDRA_LEO_MISSING_COMMA)
45-48: Use Consistent Language Identifier in Code Block
The code block for settingconfig.i18n_output_formatuses the marker "rb". For consistency with other Ruby code blocks in the document (which use "ruby"), consider updating it as shown below:- ```rb + ```ruby
97-99: Refined Notes Section for Improved Readability
The notes have been reformatted to enhance readability and consistency. As a minor nitpick, consider reviewing the phrasing in the "Outdated" note to ensure it aligns perfectly with your style guidelines.docs/guides/file-system-based-automated-bundle-generation.md (4)
163-178: Clearer File Tree Structure Display
The directory tree structure is now formatted with clear indentation and the use of symbols like "└──" and "│." This presentation makes it easier for the reader to understand the hierarchy. As a minor suggestion, consider specifying the language for the code block (for example, using "```text") to benefit from proper syntax highlighting in markdown renderers.
180-180: Clarification in React Components Registration
The instructions now inform users that registering components manually is no longer required, which simplifies the configuration process. For enhanced clarity, consider adding a comma after "For example" in the sentence to adhere to conventional punctuation standards.🧰 Tools
🪛 LanguageTool
[typographical] ~180-~180: After the expression ‘for example’ a comma is usually used.
Context: ...ry` nor directly add their bundles. For example you can have a Rails view using three c...(COMMA_FOR_EXAMPLE)
207-211: Simplify Wording for Server Rendering Section
The "Server Rendering and Client Rendering Components" section contains a sentence that feels a bit wordy. Consider rephrasing it for brevity. For example:"If server rendering is enabled, the component is registered for both server and client rendering. To have separate definitions, name the files as
ComponentName.server.jsxandComponentName.client.jsx. If server rendering isn’t desired, only include theComponentName.client.jsxfile."This change will improve clarity and conciseness.
🧰 Tools
🪛 LanguageTool
[style] ~209-~209: Consider a shorter alternative to avoid wordiness.
Context: ...ge both in server and client rendering. In order to have separate definitions for client an...(IN_ORDER_TO_PREMIUM)
213-213: Informative Note on Client/Server Rendering File Deletion
The note clarifying the need to delete the generalizedComponentName.jsxfile when using separate client and server rendering definitions is very useful. For consistency with other advisory content in the document, you might consider formatting this note as a blockquote (or using another consistent style for notes).KUDOS.md (5)
100-102: Standardized Heading and Tone Check for March 30, 2016
The "### March 30, 2016" header is consistent with other entries. Additionally, the accompanying quote—starting with "Gone are the days of using bower or rails gems…"—uses an exclamation mark. Please review whether this punctuation best suits the intended tone; if the quote is meant to retain its original style, it can remain as is.🧰 Tools
🪛 LanguageTool
[style] ~102-~102: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1997 characters long)
Context: ...ls gems to manage front end dependencies! React on Rails provides webpack integra...(EN_EXCESSIVE_EXCLAMATION)
110-112: Updated Comparative Entry for March 23, 2016, Compared to Browserify
The heading now clearly indicates a comparison with Browserify. It might be worthwhile to double-check the relevance and clarity of the comparison; if the context has evolved, consider whether additional context should be provided.
47-50: Refine Language in User Quote
In the user quote starting on this line, consider moderating informal adjectives such as "awesome" for a more formal presentation. Additionally, verify that references to the gem (currently written as "react_on_rails") follow the project's preferred capitalization or styling conventions.🧰 Tools
🪛 LanguageTool
[style] ~49-~49: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ators are great and the community is so awesome and welcoming. In fact, I love it so mu...(AWESOME)
[grammar] ~49-~49: “React” is a proper noun and needs to be capitalized.
Context: ...Rails](https://goo.gl/uzu36X) using the react_on_rails gem!" ).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
70-70: Bare URL used
null(MD034, no-bare-urls)
105-107: Replace Bare Twitter URL with Markdown Link
The Twitter link (https://twitter.com/ollieglass/status/713372606804729856) appears as a bare URL. Converting it into a markdown-styled link (e.g.,[Twitter Status](https://twitter.com/ollieglass/status/713372606804729856)) would improve readability and conform to the markdown guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
106-106: Bare URL used
null(MD034, no-bare-urls)
PROJECTS.md (3)
10-10: Support Message Formatting Improvement.
Italicizing the support message enhances its emphasis. However, a static analysis hint noted a possible missing comma in this line. Please verify that the punctuation meets the desired style guidelines.🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...You can confirm a project uses React on Rails as the source will contain **`js-react-...(AI_HYDRA_LEO_MISSING_COMMA)
13-29: Consistent List Formatting with Minor Editorial Adjustments.
Formatting for the "Commercial Products Live" section is now standardized. A couple of editorial suggestions:
- Line 15: Consider changing “, Canadian shopping site” to “, a Canadian shopping site” for improved readability.
- Line 22: Similarly, “, large French crowdfunding platform” might read better as “, a large French crowdfunding platform.”
- Line 29: Change “multi-lingual JavaScript support” to “multilingual JavaScript support” to follow conventional spelling.
Proposed diff:
- **[RedFlagDeals](https://www.redflagdeals.com/)**, Canadian shopping site. + **[RedFlagDeals](https://www.redflagdeals.com/)**, a Canadian shopping site. - **[KissKissBankBank](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. + **[KissKissBankBank](https://www.kisskissbankbank.com/)**, a large French crowdfunding platform. - **[Deliveroo](https://deliveroo.co.uk/)**: The leading food delivery site in Europe has gone live with React on Rails, with multi-lingual JavaScript support! + **[Deliveroo](https://deliveroo.co.uk/)**: The leading food delivery site in Europe has gone live with React on Rails, with multilingual JavaScript support!🧰 Tools
🪛 LanguageTool
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...eals](https://www.redflagdeals.com/)**, Canadian shopping site. - **[YourMechanic](https...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~22-~22: You might be missing the article “a” here.
Context: ...](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. - **[HVMN...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~29-~29: This word is normally spelled as one.
Context: ...has gone live with React on Rails, with multi-lingual JavaScript support! ![2016-05-03_19-1...(EN_COMPOUNDS_MULTI_LINGUAL)
56-62: Editorial Note for Projects List.
In the "Projects Based on React on Rails" section, the list items are well formatted. As a minor suggestion, consider hyphenating “open source” to “open‑source” on line 61 (if intended as a compound adjective) to improve clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ps://github.com/sharetribe/sharetribe): Open source marketplace platform.(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/misc/doctrine.md (5)
11-14: Formatting Enhancement in "Optimize for Programmer Happiness" SectionLine 12 shows a formatting modification (as indicated by the tilde) that adjusts spacing or line breaks. This change improves readability without affecting the content’s meaning.
25-30: Reformatted "Convention over Configuration" SectionThe bullet list (lines 27–29) has been reformatted with the updated Prettier configuration. The changes enhance clarity and consistency in the markdown style.
Note: A static analysis hint suggested writing “hard work” as a single word if it were meant as a noun (i.e. “workout”). However, “hard work” is the standard and correct phrasing in this context. Consider leaving it as-is.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: Write this as one word if you mean the noun “workout”.
Context: ...on - React on Rails has taken the hard work out of figuring out the JavaScript tooling ...(WORK_COMPOUNDS)
[grammar] ~27-~27: Using the adverb ‘altogether’ may be more appropriate in this context.
Context: ...u'd have to figure out how to splice it all together. This is where a lot of "JavaScript fat...(ALTOGETHER)
61-64: Suggestion: Hyphenate Compound Adjective in "Exalt Beautiful Code" SectionThe content is well formatted; however, consider hyphenating "client side" on line 63 when used as an adjective for clarity and consistency with standard style.
-Client side code written with React plus Redux,... +Client-side code written with React plus Redux,...🧰 Tools
🪛 LanguageTool
[uncategorized] ~63-~63: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... ES6 is beautiful. React is beautiful. Client side code written with React plus Redux, ful...(EN_COMPOUND_ADJECTIVE_INTERNAL)
65-72: Refinement in "Value Integrated Systems" SectionThe bullet points clearly outline the integration benefits. On line 67, the phrase “with lots of business rules” could be refined to a more formal alternative such as “with many business rules” for improved tone.
- (document/database based with lots of business rules) + (document/database based with many business rules)🧰 Tools
🪛 LanguageTool
[style] ~67-~67: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...for Rails (document/database based with lots of business rules), the tight integration ...(A_LOT_OF)
73-80: Consistent Adjective Formatting in "Progress over Stability" SectionThe list items (lines 77–79) now reflect the updated formatting style. Consider hyphenating “client side” to “client-side” on line 78 if it is meant as a compound adjective.
- - New client side tooling, libraries, and techniques. + - New client-side tooling, libraries, and techniques.🧰 Tools
🪛 LanguageTool
[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p with: - Community suggestions. - New client side tooling, libraries, and techniques. - U...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/react-helmet.md (1)
47-47: Improved Layout Before Nonworking Example
The additional whitespace before the snippet that illustrates an incorrect usage clarifies the document’s structure. Consider adding a brief note explicitly stating that the following snippet is intentionally demonstrating what not to do.docs/getting-started.md (2)
144-144: Compound Adjective Consistency
Consider hyphenating the compound adjective for clarity. For example, use “server-side entry file” instead of “server side entry file” to enhance readability.-...a different server side entry file, like 'serverRegistration.js' +...a different server-side entry file, like 'serverRegistration.js'🧰 Tools
🪛 LanguageTool
[uncategorized] ~144-~144: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...(EN_COMPOUND_ADJECTIVE_INTERNAL)
137-137: Heading Level Increment Concern
The heading “#### Different Server-Side Rendering Code (and a Server-Specific Bundle)” at line 137 jumps from a lower-level heading without an intermediate level. For a more logical document structure, consider changing it to a level-3 header (i.e. using###) unless this hierarchy is intentional.docs/contributor-info/linters.md (2)
10-11: Clarify RuboCop Directory Instruction
The reformatted instruction now clearly directs users to operate in the correct directory for Ruby files. Consider varying the phrase “in the right directory” if similar wording appears elsewhere in the document to avoid repetition.
68-71: Streamlined Reference Links Bullet List
The reformatted bullet list for Useful Reference Links enhances clarity and consistency. However, please review whether including multiple ESLint-related links (e.g., "Configuring ESLint", "ESLint quick start", and "ESLint") is intentional or if it might be streamlined to reduce any potential redundancy.🧰 Tools
🪛 LanguageTool
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ... Useful Reference Links - Configuring ESLint - [ESLint quick start](http://untilfalse.com/esli...(ENGLISH_WORD_REPEAT_RULE)
docs/additional-details/recommended-project-structure.md (5)
48-50: Improved Formatting in Styling Assets Section.
The rewording and formatting improvements in this section enhance readability. Consider revising the informal phrase "It depends!" to a more neutral tone, such as "This depends on your project requirements."🧰 Tools
🪛 LanguageTool
[style] ~50-~50: Consider an alternative adjective to strengthen your wording.
Context: ...s asset pipeline? It depends! Here's a good discussion of this option: [Why does Ra...(GOOD_CONSTRUCTIVE)
55-56: Clarify Expression in Rails Styling Explanation.
The sentence in this section ("This isn't really any technique, as you keep handling all your styling assets using Rails standard tools...") could be rephrased for better clarity and grammatical consistency. For example, consider: "This method simply leverages Rails’ standard tools for handling styling assets."🧰 Tools
🪛 LanguageTool
[uncategorized] ~56-~56: Possible missing comma found.
Context: ...t get involved with styling. Your Rails layouts just doing the styling the standard Rai...(AI_HYDRA_LEO_MISSING_COMMA)
58-58: Grammar Correction in Advantages List.
Consider revising "There's no changes really from your current processes" to "There are no changes to your current processes" for improved grammatical accuracy.
67-69: Refine Directory Structure List Formatting.
The directory structure list is informative. A minor punctuation adjustment (if needed) can further improve clarity—for example, ensuring consistent colon usage and spacing throughout the list items.🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ctory structure 1./client/app/assets: Assets for CSS for client app. 1. `/cli...(UNLIKELY_OPENING_PUNCTUATION)
32-32: Remove Trailing Punctuation from Heading.
The heading "## Moving node_modules from/to/clientwith a custom webpack setup." ends with a period, which violates markdownlint MD026. Removing the trailing punctuation would help adhere to the project's formatting standards.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
32-32: Trailing punctuation in heading
Punctuation: '.'(MD026, no-trailing-punctuation)
docs/javascript/react-router.md (2)
37-40: Clarify Render-Function Explanation & Language Consistency
The descriptive text now explains that the render function might not return an object with arenderedHtmlproperty and advises to callrenderToString(). For improved clarity, consider rephrasing as:“Your render function may not return an object with a
renderedHtmlproperty; therefore, callrenderToString()and return an object containing that property.”Additionally, in line 40 the phrase “server side bundle” would read more naturally as “server-side bundle”.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...dering** and should be only used in the server side bundle. From the [original example in ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
66-68: Review Prop Usage in StaticRouter
TheStaticRoutercomponent is currently passed a prop viaprops={props}. According to standard usage,StaticRoutertypically accepts onlylocationandcontext(and optionallybasename), so consider removing the extraneouspropsunless it serves a specific, documented purpose in your implementation.spec/dummy/client/README.md (3)
9-9: Trailing Punctuation in Heading
The header “# Running linter:” includes trailing punctuation. Consider removing the colon to comply with markdownlint (MD026).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
9-9: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
21-23: Enhance Code Block Readability
For the fenced code block displaying the commandyarn global add npm-check-updates, adding a language specifier (e.g.sh) would improve syntax highlighting and satisfy markdown lint rules (MD040).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
21-21: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
21-21: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
25-30: Specify Language for Fenced Code Block
The code block showing the commands for entering the client directory and running updates would benefit from a language indicator (such asshorbash) to enhance clarity and compliance with markdown guidelines (MD040, MD046).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
25-25: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
25-25: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
README.md (1)
86-87: Phrasing for Conditional Rendering Tip
The bullet point “How to conditionally render server side based on the device type” may benefit from rephrasing to avoid splitting the infinitive (e.g. “How to render on the server conditionally”).🧰 Tools
🪛 LanguageTool
[style] ~87-~87: Style-wise, it’s not ideal to insert an adverb (‘conditionally’) in the middle of an infinitive construction (‘to render’). Try moving the adverb to avoid split infinitives.
Context: ...lient-and-server-rendering/1352) - [How to conditionally render server side based on the device type](https://forum...(SPLIT_INFINITIVE)
docs/home.md (1)
21-22: Bullet Indentation and Language Correction
The indentation for the second bullet point under “Example Apps” now clearly ties the continuation to the main list item. Also, consider changing “a new way to setup the creation of your SSR bundle” to “a new way to set up the creation of your SSR bundle” for grammatical accuracy.🧰 Tools
🪛 LanguageTool
[grammar] ~22-~22: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `s...(NOUN_VERB_CONFUSION)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (4)
19-20: Grammar Improvement for Informal Phrase
On line 19, the phrase "a couple options" could be revised to "a couple of options" to maintain a formal tone throughout the documentation.🧰 Tools
🪛 LanguageTool
[grammar] ~19-~19: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ... server-side rendering, then you have a couple options. The recommended technique is to have a...(PLENTY_OF_NOUNS)
88-90: Clarify Plugin Configuration Explanation
The note on line 88 explaining the addition of theoverlay.sockPortoption is helpful. Consider adjusting the sentence for grammatical precision—for example, changing “makes SockJS works properly” to “makes SockJS work properly” and adding “the” before “browser console” if needed.🧰 Tools
🪛 LanguageTool
[uncategorized] ~88-~88: You might be missing the article “the” here.
Context: ... }), ); } ``` We addedoverlay.sockPortoption in `ReactRefres...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~88-~88: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...fig/shakapacker.yml`. This makes SockJS works properly and fixes this error in browse...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~88-~88: You might be missing the article “the” here.
Context: ... works properly and fixes this error in browser console: `GET http://localhost:[port]/s...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
101-101: Minor Text Correction in Post-Configuration Note
Consider rephrasing “Now Browser should reflect...” to “Now the browser should reflect...” for better readability and consistency with standard English conventions.
103-103: Refine Conditional Fallback Instructions
The sentence on line 103 can be made clearer. For example, rephrase it to: “If, for some reason, the plugin doesn't work, you may revert to only enabling devServer hmr/inline for CSS files.” This would enhance clarity and grammatical correctness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~103-~103: A comma might be missing here.
Context: ...ding. If by some reason plugin doesn't work you could revert changes and left only ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~103-~103: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ... devServer hmr/inline to true affecting only css files. These plugins are working a...(ADVERB_REPETITION_PREMIUM)
docs/guides/tutorial.md (2)
72-73: Grammatical Improvement Suggestion
In the note regarding the Postgresql database option, consider inserting the definite article for clarity. For example:-Note: You can use `--database=postgresql` option to use Postgresql for the database. +Note: You can use the `--database=postgresql` option to use Postgresql for the database.
367-369: Procfile.dev Example and Explanatory Text
The example in the Procfile.dev code block is correctly formatted. As a suggestion, review the preceding explanatory text for enhanced punctuation—adding a comma after “0.0.0.0” (e.g., “...using IP 0.0.0.0, and PORT 8080…”) would improve clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~368-~368: A comma might be missing here.
Context: ...ample, to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
CONTRIBUTING.md (4)
21-22: Minor Punctuation Improvement Suggested
In the sentence “It's critical to configure your IDE/editor to ignore certain directories. Otherwise your IDE might slow to a crawl!” consider adding a comma after “Otherwise” (i.e. “Otherwise, your IDE might slow…”) to improve clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...E/editor to ignore certain directories. Otherwise your IDE might slow to a crawl! - /cov...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
80-83: Clarify Workflow Step Wording
The workflow instructions are detailed; however, consider rephrasing the second step from “We need yalc to push and then run yarn:” to something like “Next, push your changes using yalc and then run yarn to update dependencies” for improved clarity.🧰 Tools
🪛 LanguageTool
[style] ~81-~81: Consider shortening or rephrasing this to strengthen your wording.
Context: ...eact-on-rails ``` The workflow is: 1. Make changes to the node package. 2. We need yalc to pu...(MAKE_CHANGES)
184-186: Rephrase Suggested for Dummy App Startup Instructions
While the emphasis on not using justrails sis important, consider rewording the consecutive sentences that begin with “If” to reduce repetition and improve overall flow.🧰 Tools
🪛 LanguageTool
[style] ~185-~185: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...figs, then you need to restart foreman. If you change the JS code for react-on-rai...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
242-242: Minor Wording Suggestion for Docker Build Instruction
Consider rephrasing “after the install” to “after installation” to enhance the professionalism and clarity of the message.🧰 Tools
🪛 LanguageTool
[grammar] ~242-~242: The word ‘install’ is not a noun.
Context: ...he initial build is slow, but after the install, startup is very quick. ### Linting Co...(A_INSTALL)
[style] ~242-~242: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...slow, but after the install, startup is very quick. ### Linting Commands Runrake lint...(EN_WEAK_ADJECTIVE)
docs/rails/turbolinks.md (4)
16-16: Reminder: Address the TODO note.
The TODO on line 16 highlights the need to walk through code changes in PR 1620. Once reviewed, consider updating this note or removing it if it’s no longer applicable.
26-30: Clarification in the “Why Turbolinks?” section.
The explanation of performance benefits when switching between Rails HTML controller requests is clearer. A minor punctuation tweak (e.g. adding a comma between clauses) might further enhance readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~29-~29: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...reload JavaScript and stylesheets. This definitely can make an app perform better, even if the...(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
37-41: Bullet numbering in “Why Not Turbolinks”.
Both bullet points are numbered “1.” which many markdown processors auto-enumerate correctly. Verify that your renderer displays them as intended; otherwise, consider sequential numbering for extra clarity.
44-46: Refine “More Information” bullet for clarity and grammar.
The detailed bullet discussing CSRF tokens (lines 44–45) contains several punctuation and grammatical issues (such as missing commas and articles). For example, consider a revision along these lines:- CSRF tokens need thorough checking with Turbolinks5. Turbolinks5 changes the head element by JavaScript (not only body) on page changes with the correct csrf meta tag, but if the JS code parsed this from head when several windows were opened, then our specs were not all passing. I didn't look details however, may be it is app code related, not library code. Anyway it may need additional check because there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. + CSRF tokens require thorough verification with Turbolinks5. Note that Turbolinks5 alters the head element (not just the body) on page changes to include the correct CSRF meta tag. However, if the JS code parsed this tag from the head in scenarios where several windows were open, our specs might not pass. I have not looked into the details—it may be due to the application code rather than the library. In any case, additional checks may be necessary since the CSRF helper in ReactOnRails must work correctly with Turbolinks5.Refining this wording will improve clarity and ensure consistency.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...he head element by JavaScript (not only body) on page changes with the correct csrf ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...ag, but if the JS code parsed this from head when several windows were opened, then ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~44-~44: Consider inserting a comma before ‘however’.
Context: ...ecs were not all passing. I didn't look details however, may be it is app code related, not libr...(HOWEVER_MISSING_COMMA)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ... is app code related, not library code. Anyway it may need additional check because th...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~44-~44: You might be missing the article “a” here.
Context: ... need additional check because there is CSRF helper in ReactOnRails and it need to w...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Tur...(COMMA_COMPOUND_SENTENCE)
[grammar] ~44-~44: The pronoun ‘it’ requires a third-person verb or a past tense.
Context: ...e is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Turbolinks5...(HE_NEED)
docs/release-notes/15.0.0.md (3)
5-9: Clarify the React Server Components Support Section
The introductory text now emphasizes full RSC integration with the line “Experience the future of React with full RSC integration in your Rails apps:” which works well. However, note that the explicit bullet “Seamlessly use React Server Components” has been removed. Ensure that this removal was intentional and that the overall tone remains clear for your users.
14-23: Validate Improved Component Hydration Description
The “Improved Component Hydration” section now clearly lists several benefits. As a minor nitpick, consider checking if “no fear of race condition” should be pluralized to “no fear of race conditions” for consistency.
26-30: Detail Breaking Changes in Hydration Configuration
The updated defaults fordefer_generated_component_packsandforce_loadare clearly communicated, and the explanation regarding the elimination of the need to defer scripts is helpful. If possible, consider briefly explaining the rationale behind these new default values to offer additional context to users.🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...l hydrate early without waiting for the full page load. This improves performance by elim...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/upgrading-react-on-rails.md (5)
36-41: Revised i18n Default Format Guidance
The instructions for projects using the internalization helper now advise settingconfig.i18n_output_format = 'js'. Consider verifying that this recommendation aligns with the latest best practices.🧰 Tools
🪛 LanguageTool
[uncategorized] ~41-~41: Possible missing comma found.
Context: ... can later update to the default JSON format as you will need to update your usage o...(AI_HYDRA_LEO_MISSING_COMMA)
72-83: Code Examples for Functions Returning an Object
Two consecutive examples illustrate how to modify functions that return an object rather than a React element. They both show an arrow function with two parameters returning an object withrenderedHTML. Please verify if both examples are intended to be identical or if they should emphasize different scenarios.
153-157: Refined Explanation of Webpacker Benefits in v9 Upgrade
The “Why Webpacker?” section now succinctly outlines its advantages. While the content is informative, consider a quick review of punctuation (such as comma usage) per the static analysis hints.
162-183: Comprehensive Migration Steps for Version 7 or Lower
The detailed list of changes for projects still using aclientdirectory is thorough and methodical. If possible, consider breaking the list into sub-sections to improve readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~165-~165: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ndles to bypass the Rails asset pipeline and it's extra minification, enabling you t...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ... yourclientdirectory -.gitignore: add/public/webpack/*-Gemfile: bu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ...config/initializers/react_on_rails.rb: - Delete `config.generated_assets_dir...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~178-~178: The verb ‘Replace’ is plural. Did you mean: “replaces”? Did you use a verb instead of a noun?
Context: ...onfig now supplies this information - Replace `config.npm_build_(test|production)_com...(PLURAL_VERB_AFTER_THIS)
[uncategorized] ~179-~179: A comma might be missing here.
Context: ...commend setting dev_server.hmr to false however since HMR is currently broken. - `clien...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~180-~180: Loose punctuation mark.
Context: ...urrently broken. -client/package.json: bumpreact_on_rails(I recommend bump...(UNLIKELY_OPENING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
182-182: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
1-320: Overall Language and Style Improvements
Several static analysis hints suggest minor punctuation, comma usage, and phrasing improvements (e.g., potential missing commas and compound adjective adjustments). Although not critical, addressing these suggestions could further enhance the document’s clarity and professionalism.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nfiguration to a better setup ready for Server Side Rendering. ## Upgrading to v13 ### Br...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~41-~41: Possible missing comma found.
Context: ... can later update to the default JSON format as you will need to update your usage o...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~45-~45: Consider a shorter alternative to avoid wordiness.
Context: ...ated API forReactOnRails.register()In order to solve the issues regarding React Hooks ...(IN_ORDER_TO_PREMIUM)
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ion will be treated as a render function and it can return an Object rather than a R...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~85-~85: Possible missing comma found.
Context: ...ion or class component**. _Migration is needed as the older syntax returned a React El...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~114-~114: A comma might be missing here.
Context: ... {...props} />` in a function call like this which results in the return value being...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...webpack builds should set this value to true or else no CSS link tags are generated....(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~133-~133: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...(https://github.com/rails/webpacker) to setup your Webpack configuration. ```yml def...(NOUN_VERB_CONFUSION)
[uncategorized] ~144-~144: The preposition “by” seems more likely in this position.
Context: ..._RAILS"] usage. You can get all tracing with either specifyingtraceat your c...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~145-~145: Possible missing preposition found.
Context: ...des to enable component and other types caching with React on Rails. ## Upgrading to v...(AI_HYDRA_LEO_MISSING_OF)
[uncategorized] ~160-~160: Possible missing comma found.
Context: ...maps in production. This is 100% a best practice as source maps in production greatly in...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~165-~165: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ndles to bypass the Rails asset pipeline and it's extra minification, enabling you t...(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ... yourclientdirectory -.gitignore: add/public/webpack/*-Gemfile: bu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ...config/initializers/react_on_rails.rb: - Delete `config.generated_assets_dir...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~178-~178: The verb ‘Replace’ is plural. Did you mean: “replaces”? Did you use a verb instead of a noun?
Context: ...onfig now supplies this information - Replace `config.npm_build_(test|production)_com...(PLURAL_VERB_AFTER_THIS)
[uncategorized] ~179-~179: A comma might be missing here.
Context: ...commend setting dev_server.hmr to false however since HMR is currently broken. - `clien...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~180-~180: Loose punctuation mark.
Context: ...urrently broken. -client/package.json: bumpreact_on_rails(I recommend bump...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~225-~225: This phrase is duplicated. You should probably use “Run Run” only once.
Context: ...rade RoR in theclient/package.json- Runbundle- Runrails webpacker:install- Runrails webpacker:install:react- Runrails g react_on_rails:install- Move...(PHRASE_REPETITION)
[style] ~242-~242: This phrase is redundant. Consider using “inside”.
Context: ...toconfig/initializers/react_on_rails.rbto keep your node_modules inside of/client2. Renamed - config.npm_b...(OUTSIDE_OF)
[formatting] ~269-~269: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...name,** unless the bundle is server side.: ``` const webpackConfigLoader ...(DOUBLE_PUNCTUATION_PREMIUM)
[duplication] ~300-~300: Possible typo: you repeated a word.
Context: ...packer.yml - If you are not using the webpacker webpacker setup, be sure to put in `compile: fals...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~319-~319: You might be missing the article “the” here.
Context: ...dummy/config/webpacker.yml. - Remove keyshot_reloading_hostandhot_reloading...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
52-52: Heading levels should only increment by one level at a time
Expected: h4; Actual: h5(MD001, heading-increment)
52-52: Trailing punctuation in heading
Punctuation: '.'(MD026, no-trailing-punctuation)
64-64: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
143-143: Bare URL used
null(MD034, no-bare-urls)
182-182: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
186-186: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
197-197: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
207-207: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
271-271: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
289-289: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
299-299: Bare URL used
null(MD034, no-bare-urls)
303-303: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
307-307: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
311-311: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
docs/outdated/rails-assets-relative-paths.md (3)
67-67: Typographical Improvement: Punctuation for Abbreviations
Consider adding a period after “etc” for consistency with American English style.-... (.png, .jpg, etc) +... (.png, .jpg, etc.)🧰 Tools
🪛 LanguageTool
[style] ~67-~67: In American English, abbreviations like “etc.” require a period.
Context: ...nsion of the original file (.png, .jpg, etc). Next we'll set the outputPath for ou...(ETC_PERIOD)
51-51: Textual Clarity in Loader Description
In the explanatory text, consider improving clarity by making the following adjustments:
- Change “both of these two example” to “both of these two examples”
- Remove “exact” to avoid redundancy (e.g., “do the same thing” instead of “do the exact same thing”)
Additionally, note that three successive sentences beginning with “For” could be reworded for better variety.-both of these two example above do the exact same thing, just using different syntaxes. +both of these two examples above do the same thing, just using different syntaxes.🧰 Tools
🪛 LanguageTool
[grammar] ~51-~51: After the number ‘two’, use a plural noun. Did you mean “examples”?
Context: ...name].[ext]', }, ``` both of these two example above do the exact same thing, just usi...(CD_NNU)
[style] ~51-~51: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ... both of these two example above do the exact same thing, just using different syntaxes. F...(EN_WORDINESS_PREMIUM_EXACT_SAME)
61-61: Minor Punctuation Improvement
For improved readability, consider inserting a comma after “For now” so that the sentence reads:“For now, we're just going to use:”
-For now we're just going to use: +For now, we're just going to use:🧰 Tools
🪛 LanguageTool
[typographical] ~61-~61: Consider adding a comma here.
Context: ...r file's resulting name after bundling. For now we're just going to use: ```javascript...(FOR_NOW_COMMA)
NEWS.md (6)
8-10: Bullet Entry Formatting for October 1 and August 2, 2020
The revised formatting—with line breaks separating the description from the link—improves clarity. One suggestion: on line 10, the phrase “a new way to setup the creation of your SSR bundle” uses “setup” as a verb. It might be clearer to use “set up” instead.- for a new way to setup the creation of your SSR bundle with `rails/webpacker`. + for a new way to set up the creation of your SSR bundle with `rails/webpacker`.🧰 Tools
🪛 LanguageTool
[grammar] ~10-~10: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `r...(NOUN_VERB_CONFUSION)
37-37: Bullet Entry for 6.0.2 Critical Fix
The entry is informative; however, for clarity, consider hyphenating or adding a comma to clarify “server generated React” as “server‐generated React”.- if you are fragment caching the server generated React. + if you are fragment caching the server-generated React.🧰 Tools
🪛 LanguageTool
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...with a critical fix if you are fragment caching the server generated React. - 2016-05-2...(AI_HYDRA_LEO_MISSING_COMMA)
48-48: Bullet Entry for Projects Page Addition
The entry is informative. Consider inserting a preposition for clarity – for example, change “edit the page your project” to “edit the page for your project.”- Please edit the page your project or [email us] + Please edit the page for your project or [email us]🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Possible missing preposition found.
Context: ...age](PROJECTS.md). Please edit the page your project or [email us](mailto:contact@sh...(AI_HYDRA_LEO_MISSING_OF)
56-56: Bullet Entry for Redux Version Workaround
The entry provides valuable context on the Redux issue and suggested workarounds. Note a minor typographical error: “lastest” should be corrected to “latest”.- lastest version of Redux + latest version of Redux
60-60: Bullet Entry for Generator Support and CSS Modules
This entry is detailed and informative. One nitpick: review the punctuation to ensure clarity—there might be a missing comma to separate clauses.🧰 Tools
🪛 LanguageTool
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...modules and hot reloading via the Rails server as is demonstrated in the [shakacode/re...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~60-~60: “React” is a proper noun and needs to be capitalized.
Context: ...._ If you did generate a fresh app from react_on_rails and want to move to CSS Module...(A_GOOGLE)
[style] ~60-~60: Using many exclamation marks might seem excessive (in this case: 20 exclamation marks for a text that’s 8677 characters long)
Context: ...information. Ping us if you want to help! - ShakaCode...(EN_EXCESSIVE_EXCLAMATION)
61-61: Bullet Entry for ShakaCode Coaching Services
The description now clearly states the coaching service details. To enhance clarity, consider hyphenating the compound modifier as follows: “Skype-plus-Slack/GitHub-based coaching.”- Skype plus Slack/GitHub based coaching + Skype-plus-Slack/GitHub-based coaching🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: This expression is usually spelled with a hyphen.
Context: ...hakacode.com) is doing Skype plus Slack/GitHub based coaching for "React on Rails". [Click h...(BASED_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (87)
.github/ISSUE_TEMPLATE/bug_report.md(0 hunks).github/ISSUE_TEMPLATE/feature_request.md(0 hunks).github/PULL_REQUEST_TEMPLATE.md(1 hunks).prettierrc(1 hunks)CHANGELOG.md(19 hunks)CONTRIBUTING.md(11 hunks)KUDOS.md(1 hunks)NEWS.md(1 hunks)PROJECTS.md(1 hunks)README.md(4 hunks)SUMMARY.md(1 hunks)docs/additional-details/generator-details.md(1 hunks)docs/additional-details/manual-installation-overview.md(1 hunks)docs/additional-details/migrating-from-react-rails.md(1 hunks)docs/additional-details/recommended-project-structure.md(2 hunks)docs/additional-details/tips-for-usage-with-sp6.md(1 hunks)docs/additional-details/updating-dependencies.md(2 hunks)docs/api/javascript-api.md(2 hunks)docs/api/redux-store-api.md(4 hunks)docs/api/view-helpers-api.md(8 hunks)docs/contributor-info/generator-testing.md(1 hunks)docs/contributor-info/linters.md(2 hunks)docs/contributor-info/pull-requests.md(2 hunks)docs/contributor-info/releasing.md(1 hunks)docs/deployment/elastic-beanstalk.md(1 hunks)docs/deployment/heroku-deployment.md(1 hunks)docs/getting-started.md(7 hunks)docs/guides/client-vs-server-rendering.md(2 hunks)docs/guides/configuration.md(4 hunks)docs/guides/file-system-based-automated-bundle-generation.md(5 hunks)docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md(1 hunks)docs/guides/how-react-on-rails-works.md(2 hunks)docs/guides/how-to-use-different-files-for-client-and-server-rendering.md(3 hunks)docs/guides/i18n.md(1 hunks)docs/guides/installation-into-an-existing-rails-app.md(2 hunks)docs/guides/minitest-configuration.md(1 hunks)docs/guides/rails-webpacker-react-integration-options.md(7 hunks)docs/guides/react-on-rails-overview.md(1 hunks)docs/guides/react-server-rendering.md(2 hunks)docs/guides/render-functions-and-railscontext.md(6 hunks)docs/guides/rspec-configuration.md(4 hunks)docs/guides/streaming-server-rendering.md(4 hunks)docs/guides/tutorial.md(12 hunks)docs/guides/upgrading-react-on-rails.md(13 hunks)docs/guides/webpack-configuration.md(2 hunks)docs/home.md(2 hunks)docs/javascript/angular-js-integration-migration.md(2 hunks)docs/javascript/capistrano-deployment.md(1 hunks)docs/javascript/code-splitting.md(5 hunks)docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md(1 hunks)docs/javascript/credits.md(0 hunks)docs/javascript/foreman-issues.md(1 hunks)docs/javascript/images.md(0 hunks)docs/javascript/node-dependencies-and-npm.md(1 hunks)docs/javascript/react-and-redux.md(1 hunks)docs/javascript/react-helmet.md(6 hunks)docs/javascript/react-router.md(2 hunks)docs/javascript/server-rendering-tips.md(2 hunks)docs/javascript/troubleshooting-when-using-shakapacker.md(1 hunks)docs/javascript/troubleshooting-when-using-webpacker.md(1 hunks)docs/javascript/webpack-v1-notes.md(1 hunks)docs/javascript/webpack.md(1 hunks)docs/misc/articles.md(1 hunks)docs/misc/doctrine.md(2 hunks)docs/misc/style.md(1 hunks)docs/misc/tips.md(1 hunks)docs/outdated/deferred-rendering.md(2 hunks)docs/outdated/rails-assets-relative-paths.md(8 hunks)docs/outdated/rails-assets.md(2 hunks)docs/outdated/rails3.md(1 hunks)docs/rails/rails-engine-integration.md(2 hunks)docs/rails/rails_view_rendering_from_inline_javascript.md(2 hunks)docs/rails/turbolinks.md(3 hunks)docs/release-notes/15.0.0.md(3 hunks)docs/testimonials/resortpass.md(1 hunks)docs/testimonials/testimonials.md(1 hunks)knip.ts(1 hunks)lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.module.css(1 hunks)node_package/src/ClientSideRenderer.ts(10 hunks)package-scripts.yml(2 hunks)package.json(1 hunks)spec/dummy/README.md(2 hunks)spec/dummy/app/assets/stylesheets/application_non_webpack.scss(1 hunks)spec/dummy/client/README.md(3 hunks)spec/dummy/client/app/components/CssModulesImagesFontsExample.module.scss(2 hunks)spec/dummy/client/app/components/ImageExample/ImageExample.module.scss(1 hunks)spec/dummy/client/app/startup/RouterApp.server.jsx(1 hunks)
💤 Files with no reviewable changes (4)
- .github/ISSUE_TEMPLATE/feature_request.md
- docs/javascript/images.md
- .github/ISSUE_TEMPLATE/bug_report.md
- docs/javascript/credits.md
🚧 Files skipped from review as they are similar to previous changes (37)
- docs/deployment/heroku-deployment.md
- docs/guides/react-on-rails-overview.md
- docs/misc/articles.md
- docs/testimonials/testimonials.md
- spec/dummy/app/assets/stylesheets/application_non_webpack.scss
- docs/additional-details/updating-dependencies.md
- spec/dummy/client/app/startup/RouterApp.server.jsx
- docs/contributor-info/releasing.md
- docs/guides/rspec-configuration.md
- knip.ts
- SUMMARY.md
- docs/guides/react-server-rendering.md
- docs/javascript/troubleshooting-when-using-webpacker.md
- docs/javascript/react-and-redux.md
- docs/javascript/node-dependencies-and-npm.md
- docs/guides/configuration.md
- docs/additional-details/migrating-from-react-rails.md
- docs/javascript/troubleshooting-when-using-shakapacker.md
- lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.module.css
- .github/PULL_REQUEST_TEMPLATE.md
- docs/guides/streaming-server-rendering.md
- docs/guides/installation-into-an-existing-rails-app.md
- docs/guides/client-vs-server-rendering.md
- docs/outdated/deferred-rendering.md
- spec/dummy/client/app/components/ImageExample/ImageExample.module.scss
- docs/javascript/code-splitting.md
- docs/guides/minitest-configuration.md
- docs/guides/rails-webpacker-react-integration-options.md
- package.json
- .prettierrc
- docs/rails/rails_view_rendering_from_inline_javascript.md
- spec/dummy/client/app/components/CssModulesImagesFontsExample.module.scss
- node_package/src/ClientSideRenderer.ts
- CHANGELOG.md
- docs/api/redux-store-api.md
- docs/api/javascript-api.md
- docs/additional-details/tips-for-usage-with-sp6.md
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~22-~22: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...E/editor to ignore certain directories. Otherwise your IDE might slow to a crawl! - /cov...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~81-~81: Consider shortening or rephrasing this to strengthen your wording.
Context: ...eact-on-rails ``` The workflow is: 1. Make changes to the node package. 2. We need yalc to pu...
(MAKE_CHANGES)
[style] ~185-~185: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...figs, then you need to restart foreman. If you change the JS code for react-on-rai...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~205-~205: A comma might be missing here.
Context: .... ### Install Generator In your Rails app add this gem with a path to your fork. ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~237-~237: The word ‘lint’ is a noun or an adjective. A verb or adverb is missing or misspelled here, or maybe a comma is missing.
Context: ...changes via the lint container. You can lint locally by running `npm run lint && npm...
(PRP_MD_NN)
[grammar] ~242-~242: The word ‘install’ is not a noun.
Context: ...he initial build is slow, but after the install, startup is very quick. ### Linting Co...
(A_INSTALL)
[style] ~242-~242: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...slow, but after the install, startup is very quick. ### Linting Commands Run rake lint...
(EN_WEAK_ADJECTIVE)
KUDOS.md
[style] ~49-~49: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ators are great and the community is so awesome and welcoming. In fact, I love it so mu...
(AWESOME)
[grammar] ~49-~49: “React” is a proper noun and needs to be capitalized.
Context: ...Rails](https://goo.gl/uzu36X) using the react_on_rails gem!" ![The Complete React on ...
(A_GOOGLE)
[style] ~102-~102: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1997 characters long)
Context: ...ls gems to manage front end dependencies! React on Rails provides webpack integra...
(EN_EXCESSIVE_EXCLAMATION)
NEWS.md
[grammar] ~10-~10: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `r...
(NOUN_VERB_CONFUSION)
[uncategorized] ~12-~12: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v12**. 1. React Hooks Support for top level components 2. Typescript bindings...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ...rformance improvements! Please upgrade! Only "breaking" change is that you have to u...
(AI_EN_LECTOR_MISSING_DETERMINER)
[inconsistency] ~29-~29: Did you mean to refer to the current year? November 10, 2025 is not a Thursday, but a Monday.
Context: ...) - 2016-11-03: Spoke at [LA Ruby, 7pm, Thursday, November 10 in Venice, CA: "React on Rails: Why, Wh...
(EN_DATE_WEEKDAY_CURRENTYEAR)
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...with a critical fix if you are fragment caching the server generated React. - 2016-05-2...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~48-~48: Possible missing preposition found.
Context: ...age](PROJECTS.md). Please edit the page your project or [email us](mailto:contact@sh...
(AI_HYDRA_LEO_MISSING_OF)
[style] ~49-~49: Consider an alternative verb to strengthen your wording.
Context: ...md) for details, and let us know if you see any issues! [Migration steps from 1.x](...
(IF_YOU_HAVE_THIS_PROBLEM)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...modules and hot reloading via the Rails server as is demonstrated in the [shakacode/re...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~60-~60: “React” is a proper noun and needs to be capitalized.
Context: ...._ If you did generate a fresh app from react_on_rails and want to move to CSS Module...
(A_GOOGLE)
[style] ~60-~60: Using many exclamation marks might seem excessive (in this case: 20 exclamation marks for a text that’s 8677 characters long)
Context: ...information. Ping us if you want to help! - ShakaCode...
(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~61-~61: This expression is usually spelled with a hyphen.
Context: ...hakacode.com) is doing Skype plus Slack/GitHub based coaching for "React on Rails". [Click h...
(BASED_HYPHEN)
PROJECTS.md
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...You can confirm a project uses React on Rails as the source will contain **`js-react-...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...eals](https://www.redflagdeals.com/)**, Canadian shopping site. - **[YourMechanic](https...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~22-~22: You might be missing the article “a” here.
Context: ...](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. - **[HVMN...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~29-~29: This word is normally spelled as one.
Context: ...has gone live with React on Rails, with multi-lingual JavaScript support! ![2016-05-03_19-1...
(EN_COMPOUNDS_MULTI_LINGUAL)
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...lational Marketing for Real Estate. ## Open Source Projects Live - [github.com/empirical-...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ps://github.com/sharetribe/sharetribe): Open source marketplace platform.
(EN_COMPOUND_ADJECTIVE_INTERNAL)
README.md
[style] ~87-~87: Style-wise, it’s not ideal to insert an adverb (‘conditionally’) in the middle of an infinitive construction (‘to render’). Try moving the adverb to avoid split infinitives.
Context: ...lient-and-server-rendering/1352) - [How to conditionally render server side based on the device type](https://forum...
(SPLIT_INFINITIVE)
docs/additional-details/generator-details.md
[style] ~44-~44: This phrase is redundant. Consider using “inside”.
Context: ...f functionality is given its own folder inside of app/javascript/app/bundles. This enco...
(OUTSIDE_OF)
[style] ~45-~45: This phrase is redundant. Consider using “Inside”.
Context: ...is encourages modularity of domains. Inside of the generated "HelloWorld" domain you w...
(OUTSIDE_OF)
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...find the following folders: - startup: contains the entry point files for webp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...or decreased bundle size. - containers: contains "smart components" (components...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...child "dumb components"). - components: contains "dumb components", or componen...
(UNLIKELY_OPENING_PUNCTUATION)
docs/additional-details/manual-installation-overview.md
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...eet_pack_tagandjavascript_pack_tag` helpers which is used to load the bundled asset...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...and javascript_pack_tag helpers which is used to load the bundled assets to your...
(AI_HYDRA_LEO_CPT_IS_ARE)
docs/additional-details/recommended-project-structure.md
[style] ~50-~50: Consider an alternative adjective to strengthen your wording.
Context: ...s asset pipeline? It depends! Here's a good discussion of this option: [Why does Ra...
(GOOD_CONSTRUCTIVE)
[uncategorized] ~56-~56: Possible missing comma found.
Context: ...t get involved with styling. Your Rails layouts just doing the styling the standard Rai...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~60-~60: Did you mean “There are no changes”?
Context: ... the Simple Rails Way 1. Much simpler! There's no changes really from your current processes. ##...
(THERE_S_MANY)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ctory structure 1. /client/app/assets: Assets for CSS for client app. 1. `/cli...
(UNLIKELY_OPENING_PUNCTUATION)
docs/api/view-helpers-api.md
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... you want to see the server side or the client side rails_context. Typically, for computing...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/contributor-info/generator-testing.md
[style] ~3-~3: This phrase is redundant. Consider writing “various” or “different”.
Context: ...ct_on_rails/install_generator.rb)) with various different options. We can then run tests with the...
(VARIOUS_DIFFERENT)
docs/contributor-info/linters.md
[style] ~16-~16: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...` 3. eslint:: Be sure to be in the right directory where you have JS files. ```...
(REP_RIGHT)
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ... Useful Reference Links - Configuring ESLint - [ESLint quick start](http://untilfalse.com/esli...
(ENGLISH_WORD_REPEAT_RULE)
docs/contributor-info/pull-requests.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...# Checklist before Committing 1. rake: runs all linters and specs (you need Do...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Possible missing article found.
Context: ...d entry? For non-doc fixes: - Provide changelog entry in the [unreleased section of the...
(AI_HYDRA_LEO_MISSING_A)
docs/deployment/elastic-beanstalk.md
[uncategorized] ~45-~45: Possible missing comma found.
Context: ...mpile. Also, it creates /home/webapp` directory allowing the precompile task to create ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~47-~47: “React” is a proper noun and needs to be capitalized.
Context: ...ic beanstalk successfully. However, the react app javascript files are under `public/...
(A_GOOGLE)
docs/getting-started.md
[uncategorized] ~144-~144: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/file-system-based-automated-bundle-generation.md
[typographical] ~180-~180: After the expression ‘for example’ a comma is usually used.
Context: ...ry` nor directly add their bundles. For example you can have a Rails view using three c...
(COMMA_FOR_EXAMPLE)
[style] ~209-~209: Consider a shorter alternative to avoid wordiness.
Context: ...ge both in server and client rendering. In order to have separate definitions for client an...
(IN_ORDER_TO_PREMIUM)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...efresh). For use with webpack, see **Client Side rendering and HMR using react-refresh-w...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~17-~17: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...cker-dev-server` during development. # Server Side Rendering with the Default shakacode/sh...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~19-~19: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ... server-side rendering, then you have a couple options. The recommended technique is to have a...
(PLENTY_OF_NOUNS)
[uncategorized] ~88-~88: You might be missing the article “the” here.
Context: ... }), ); } ``` We added overlay.sockPort option in `ReactRefres...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~88-~88: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...fig/shakapacker.yml`. This makes SockJS works properly and fixes this error in browse...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~88-~88: You might be missing the article “the” here.
Context: ... works properly and fixes this error in browser console: `GET http://localhost:[port]/s...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~103-~103: A comma might be missing here.
Context: ...ding. If by some reason plugin doesn't work you could revert changes and left only ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~103-~103: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ... devServer hmr/inline to true affecting only css files. These plugins are working a...
(ADVERB_REPETITION_PREMIUM)
docs/guides/how-to-use-different-files-for-client-and-server-rendering.md
[uncategorized] ~7-~7: Possible missing comma found.
Context: .... This only works for a top-level entry point such as the entry point for a react-rou...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/i18n.md
[grammar] ~30-~30: Normally, after “try to” a verb is expected.
Context: ... as well. > [!NOTE] > If you try to lint before running tests, and you depend on...
(WANT_TO_NN)
[uncategorized] ~34-~34: Possible missing comma found.
Context: ...he translations before running the lint command or > 2. to run the tests first. 4. ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/render-functions-and-railscontext.md
[uncategorized] ~42-~42: You might be missing the article “an” here.
Context: ...yAppComponent; ``` --- _This would be alternate API where you have to call React.create...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[uncategorized] ~63-~63: Possible missing comma found.
Context: ...sole warning if you try to serverRender this since the value of serverSide will be...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/guides/tutorial.md
[uncategorized] ~75-~75: You might be missing the article “the” here.
Context: ...t-react-on-rails ``` Note: You can use --database=postgresql option to use Pos...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~368-~368: A comma might be missing here.
Context: ...ample, to be able to run on free Cloud9 IDE we are putting IP 0.0.0.0 and PORT 8080...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/guides/upgrading-react-on-rails.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nfiguration to a better setup ready for Server Side Rendering. ## Upgrading to v13 ### Br...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ion will be treated as a render function and it can return an Object rather than a R...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~85-~85: Possible missing comma found.
Context: ...ion or class component**. _Migration is needed as the older syntax returned a React El...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...webpack builds should set this value to true or else no CSS link tags are generated....
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~133-~133: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...(https://github.com/rails/webpacker) to setup your Webpack configuration. ```yml def...
(NOUN_VERB_CONFUSION)
[uncategorized] ~144-~144: The preposition “by” seems more likely in this position.
Context: ..._RAILS"] usage. You can get all tracing with either specifying trace at your c...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~145-~145: Possible missing preposition found.
Context: ...des to enable component and other types caching with React on Rails. ## Upgrading to v...
(AI_HYDRA_LEO_MISSING_OF)
[uncategorized] ~160-~160: Possible missing comma found.
Context: ...maps in production. This is 100% a best practice as source maps in production greatly in...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~165-~165: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ndles to bypass the Rails asset pipeline and it's extra minification, enabling you t...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ... your client directory - .gitignore: add /public/webpack/* - Gemfile: bu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ... config/initializers/react_on_rails.rb: - Delete `config.generated_assets_dir...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~178-~178: The verb ‘Replace’ is plural. Did you mean: “replaces”? Did you use a verb instead of a noun?
Context: ...onfig now supplies this information - Replace `config.npm_build_(test|production)_com...
(PLURAL_VERB_AFTER_THIS)
[uncategorized] ~179-~179: A comma might be missing here.
Context: ...commend setting dev_server.hmr to false however since HMR is currently broken. - `clien...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~180-~180: Loose punctuation mark.
Context: ...urrently broken. - client/package.json: bump react_on_rails (I recommend bump...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~225-~225: This phrase is duplicated. You should probably use “Run Run” only once.
Context: ...rade RoR in the client/package.json - Run bundle - Run rails webpacker:install - Run rails webpacker:install:react - Run rails g react_on_rails:install - Move...
(PHRASE_REPETITION)
[style] ~242-~242: This phrase is redundant. Consider using “inside”.
Context: ...toconfig/initializers/react_on_rails.rbto keep your node_modules inside of/client 2. Renamed - config.npm_b...
(OUTSIDE_OF)
[formatting] ~269-~269: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...name,** unless the bundle is server side.: ``` const webpackConfigLoader ...
(DOUBLE_PUNCTUATION_PREMIUM)
[duplication] ~300-~300: Possible typo: you repeated a word.
Context: ...packer.yml - If you are not using the webpacker webpacker setup, be sure to put in `compile: fals...
(ENGLISH_WORD_REPEAT_RULE)
docs/home.md
[grammar] ~22-~22: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `s...
(NOUN_VERB_CONFUSION)
docs/javascript/angular-js-integration-migration.md
[grammar] ~7-~7: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ave not already done this, then you can setup the ReactOnRails default JS code dire...
(NOUN_VERB_CONFUSION)
[style] ~7-~7: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style.
Context: ...inclusion this way will be no different than using the Rails asset pipeline. However...
(DIFFERENT_THAN)
docs/javascript/capistrano-deployment.md
[uncategorized] ~25-~25: A comma might be missing here.
Context: ...se of memory. Webpack consumes a lot of memory so if possible, try increasing the RAM ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/javascript/foreman-issues.md
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...ailing to finish upload file to S3 when server was started by `foreman -f Procfile.dev...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/javascript/react-helmet.md
[style] ~10-~10: Consider a shorter alternative to avoid wordiness.
Context: ...## Example Here is what you need to do in order to configure your Rails application to wor...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~36-~36: Possible missing comma found.
Context: .....props} />; ``` Or a render-function. Note you can't return just the JSX (React el...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~92-~92: You might be missing the article “an” here.
Context: ...gument it will return a hash instead of HTML string. Note, there is no need to speci...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[grammar] ~93-~93: Did you mean the proper noun or did you want to use it as a verb?
Context: ...rerender" as it would not make sense to use react_component_hash without server rendering...
(HAVE_TWITTER)
docs/javascript/react-router.md
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...dering** and should be only used in the server side bundle. From the [original example in ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/server-rendering-tips.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Your code can't reference document. Server side JS execution does not have access to `d...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/webpack-v1-notes.md
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1166 characters long)
Context: ...ment halt if Webpack cannot complete! For more details, see the documentation...
(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~7-~7: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Webpack returning a non-zero error code and you want to see all the errors, rather ...
(COMMA_COMPOUND_SENTENCE)
docs/javascript/webpack.md
[uncategorized] ~13-~13: Possible missing comma found.
Context: ... to break out libraries into a "vendor" bundle where your libraries are packaged separ...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/misc/doctrine.md
[uncategorized] ~27-~27: Write this as one word if you mean the noun “workout”.
Context: ...on - React on Rails has taken the hard work out of figuring out the JavaScript tooling ...
(WORK_COMPOUNDS)
[grammar] ~27-~27: Using the adverb ‘altogether’ may be more appropriate in this context.
Context: ...u'd have to figure out how to splice it all together. This is where a lot of "JavaScript fat...
(ALTOGETHER)
[uncategorized] ~33-~33: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...h the many parts of an application that is the same or very similar to all the oth...
(AI_HYDRA_LEO_CPT_IS_ARE)
[uncategorized] ~63-~63: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... ES6 is beautiful. React is beautiful. Client side code written with React plus Redux, ful...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~67-~67: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...for Rails (document/database based with lots of business rules), the tight integration ...
(A_LOT_OF)
[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p with: - Community suggestions. - New client side tooling, libraries, and techniques. - U...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/misc/style.md
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...n. - Anything additional goes next. ## Client Side JavaScript and React - See the [Shakac...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~40-~40: Possible missing comma found.
Context: ...icate with anybody else working on this branch and do not do this when others have unc...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/misc/tips.md
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ht now is prerender: false. NOTE: Server side rendering does not work for some compon...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~11-~11: “React” is a proper noun and needs to be capitalized.
Context: ...nt. - Be sure you can first render your react component client only before you tr...
(A_GOOGLE)
docs/outdated/rails-assets-relative-paths.md
[grammar] ~51-~51: After the number ‘two’, use a plural noun. Did you mean “examples”?
Context: ...name].[ext]', }, ``` both of these two example above do the exact same thing, just usi...
(CD_NNU)
[style] ~51-~51: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ... both of these two example above do the exact same thing, just using different syntaxes. F...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...k.github.io/docs/using-loaders.html). _For the sake of this doc, we're also going ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[typographical] ~61-~61: Consider adding a comma here.
Context: ...r file's resulting name after bundling. For now we're just going to use: ```javascript...
(FOR_NOW_COMMA)
[style] ~67-~67: In American English, abbreviations like “etc.” require a period.
Context: ...nsion of the original file (.png, .jpg, etc). Next we'll set the outputPath for ou...
(ETC_PERIOD)
docs/outdated/rails-assets.md
[uncategorized] ~8-~8: Did you mean: “By default,”?
Context: ...e other term for this is a "digest". > By default the filename of the resulting file is t...
(BY_DEFAULT_COMMA)
docs/outdated/rails3.md
[style] ~3-~3: Consider using a different verb to strengthen your wording.
Context: # Rails 3 - Please let us know if you find any issues with Rails 3. - Rails 3 is c...
(FIND_ENCOUNTER)
[style] ~5-~5: Consider using a different verb to strengthen your wording.
Context: ...not testing it for new releases. If you find an issue, you will have to submit a PR ...
(FIND_ENCOUNTER)
docs/rails/rails-engine-integration.md
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...ture: target destination option for the install generator #459](https://github.com/shak...
(A_INSTALL)
docs/rails/turbolinks.md
[typographical] ~11-~11: It seems that a comma is missing.
Context: ... obsolete. # Using Turbo To configure Turbo the following option can be set: `React...
(IN_ORDER_TO_VB_COMMA)
[uncategorized] ~29-~29: These words/punctuation marks might seem a little out of order. For clarity and coherence, try switching them around.
Context: ...reload JavaScript and stylesheets. This definitely can make an app perform better, even if the...
(AI_EN_LECTOR_REPLACEMENT_WORD_ORDER)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...he head element by JavaScript (not only body) on page changes with the correct csrf ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~44-~44: You might be missing the article “the” here.
Context: ...ag, but if the JS code parsed this from head when several windows were opened, then ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[formatting] ~44-~44: Consider inserting a comma before ‘however’.
Context: ...ecs were not all passing. I didn't look details however, may be it is app code related, not libr...
(HOWEVER_MISSING_COMMA)
[uncategorized] ~44-~44: A comma might be missing here.
Context: ... is app code related, not library code. Anyway it may need additional check because th...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~44-~44: You might be missing the article “a” here.
Context: ... need additional check because there is CSRF helper in ReactOnRails and it need to w...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Tur...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~44-~44: The pronoun ‘it’ requires a third-person verb or a past tense.
Context: ...e is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Turbolinks5...
(HE_NEED)
docs/release-notes/15.0.0.md
[uncategorized] ~28-~28: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...l hydrate early without waiting for the full page load. This improves performance by elim...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ded. - The force_load configuration make react-on-rails hydrate components imm...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...hes the client, without waiting for the full page load. - If you want to keep the previ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...zers/react_on_rails.rbfile. - If we want to keep the original behavior offorce_lo...
(REP_WANT_TO_VB)
[uncategorized] ~34-~34: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ce_loadconfiguration. - Redux store supportforce_loadoption now and it usesco...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~34-~34: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ux store support force_load option now and it uses config.force_load value as th...
(COMMA_COMPOUND_SENTENCE)
docs/testimonials/resortpass.md
[style] ~3-~3: Consider an alternative adjective to strengthen your wording.
Context: ...ted code that both works and reflects a deep understanding of the technologies and p...
(DEEP_PROFOUND)
[grammar] ~3-~3: “React” is a proper noun and needs to be capitalized.
Context: ...s and standards for our transition to a react on rails application. Just three months...
(A_GOOGLE)
spec/dummy/README.md
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e spec/dummy/client/node_modules to the top level - Be sure to install yarn dependencies ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 markdownlint-cli2 (0.17.2)
KUDOS.md
70-70: Bare URL used
null
(MD034, no-bare-urls)
106-106: Bare URL used
null
(MD034, no-bare-urls)
docs/additional-details/recommended-project-structure.md
32-32: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
docs/getting-started.md
140-140: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
docs/guides/how-react-on-rails-works.md
5-5: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
5-5: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
docs/guides/upgrading-react-on-rails.md
64-64: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
143-143: Bare URL used
null
(MD034, no-bare-urls)
182-182: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
299-299: Bare URL used
null
(MD034, no-bare-urls)
303-303: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/guides/webpack-configuration.md
41-41: Bare URL used
null
(MD034, no-bare-urls)
42-42: Bare URL used
null
(MD034, no-bare-urls)
docs/javascript/capistrano-deployment.md
16-16: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md
10-10: Bare URL used
null
(MD034, no-bare-urls)
docs/javascript/react-helmet.md
27-27: Bare URL used
null
(MD034, no-bare-urls)
docs/outdated/rails-assets.md
3-3: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
spec/dummy/client/README.md
9-9: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
21-21: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
21-21: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
25-25: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
25-25: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
⏰ Context from checks skipped due to timeout of 90000ms (6)
- GitHub Check: dummy-app-integration-tests (newest)
- GitHub Check: dummy-app-integration-tests (oldest)
- GitHub Check: examples (oldest)
- GitHub Check: rspec-package-tests (newest)
- GitHub Check: rspec-package-tests (oldest)
- GitHub Check: examples (newest)
🔇 Additional comments (275)
docs/contributor-info/generator-testing.md (2)
5-5: Approved: Clear Description of Rake TasksThe updated description for the special rake tasks and the new command (
rake run_rspec:shakapacker_examples) is clear and improves navigability.
9-9: Approved: Enhanced Link Reference and Dynamic Task ExplanationThe updated text with the direct link to
rakelib/examples_config.ymland the explanation about dynamic task creation is informative and well-structured.docs/javascript/foreman-issues.md (1)
14-15: Ensure consistency in formatting for the second bullet point.
The adjustment in alignment for the second bullet point is clear and maintains consistency with the document’s style. The revised text preserves the original intent and improves readability.package-scripts.yml (3)
4-4: Simplify Lint Command:
The lint script now directly callsnps eslint, which removes the extra complexity of running commands concurrently. This simplification improves readability and maintainability.
36-36: Unified Format Command:
Switching toprettier --write .applies a consistent formatting operation across all files. This approach aligns with the PR’s objective to support all file types uniformly under Prettier.
39-39: Standardize Format Check:
Updating the script toprettier --check .instead of using individual check commands improves the simplicity and consistency of verifying formatting across the project.docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md (1)
4-5: Whitespace Indentation CheckThe additional indentation on these lines improves readability by clearly demarcating the sub-points in the list. Ensure that this style is consistently applied across similar documentation sections.
docs/guides/how-react-on-rails-works.md (1)
38-38: Improved Readability with Visual Separator
A new line was introduced before the numbered list detailing the custom command instructions. This addition improves visual separation and overall readability of the instructions.docs/javascript/webpack-v1-notes.md (1)
10-10: Improved Section SeparationThe addition of a blank line before the "## Entry Points" header on line 10 improves the visual separation of sections, thereby enhancing the document's readability. This is a positive formatting improvement.
docs/javascript/webpack.md (5)
3-3: Improved Header Clarity
The updated header clearly highlights the focus on advanced Webpack setups while neatly incorporating examples such as "CSS Modules" and "Code Splitting." This enhances the readability of the section.
5-5: Engaging Call-to-Action
The paragraph effectively promotes the example app and premium product options. The links and descriptive text provide clear, actionable guidance for readers.
8-9: Updated Yarn Recommendation
Specifying "Yarn v1" as the current recommendation offers precise and up-to-date guidance. The revised statement is clear and direct.
17-19: Enhanced Resource References
Adding the resource links for "Implicit Common Vendor Chunk" and "Manifest File" is a valuable improvement. These references directly support users looking to optimize their vendor bundling strategy.
20-24: Modernizing with Webpack v5
The new section on Webpack v5 is well-structured, providing useful links to the release post and migration documentation. Including updated contact information further assists users during migration.docs/rails/rails-engine-integration.md (3)
3-4: Clarify Initializer Instruction Formatting
The new bullet point clearly directs users to add code at the top of theconfig/initializers/react_on_rails.rbfile. The instruction is concise and integrates well with the surrounding text.
11-12: Confirm Gemspec Dependency Instruction
This bullet point instructs users to add the dependency in their<engine_name>.gemspecfile. The instruction is clear and the accompanying code snippet reinforces the guidance.
17-18: Verify Engine Entry Point Instruction
The instruction to modifylib/<engine_name>.rbas the entry point is well-placed and clear. It appropriately leads into the sample code below.docs/misc/style.md (8)
1-2: Enhanced Visual Separation After Heading
The added blank line immediately after the "# Code Style" heading improves visual separation and overall readability.
5-7: Consistent Bullet Point Formatting in Code Style Section
The updated bullet points now clearly outline the guidelines with proper spacing. This enhances readability and consistency in the presentation of style guidelines.
10-11: Improved Structure in Client Side JavaScript and React Section
Adding a blank line before the bullet point in this section helps distinguish the section header from its content, making the link stand out better.
14-16: Clear Section Separation for Style Guides
The introduction of additional spacing before the "Style Guides to Follow" section improves the flow of the document and makes the content easier to scan.
18-21: Structured Presentation for Ruby Coding Standards
The clear, bullet-point formatting in this section (lines 18–21) enhances the guideline’s clarity without altering the underlying content.
23-27: Enhanced Readability in JavaScript Coding Standards
Introducing line breaks before each bullet in the "JavaScript Coding Standards" section aids in better visual structuring and readability.
29-31: Clarified Git Coding Standards Section
The reformatting here makes the Git coding standards easier to read and follow. The changes maintain the original content while improving layout consistency.
33-36: Improved Layout in Sass Coding Standards Section
The updated spacing and bullet formatting in this section contribute to a clearer presentation of the guidelines.docs/javascript/angular-js-integration-migration.md (2)
10-11: Enhanced Readability in "Styling and CSS Modules" Section.
The insertion of a blank line before this section helps to visually separate the header from the content, improving the overall readability of the document.
25-27: Improved Section Separation for "Overall Approach".
Adding a blank line before the content in this section clearly distinguishes the header from the body text, thereby enhancing readability and structure.docs/contributor-info/pull-requests.md (2)
22-23: Heading Level Consistency
The header "#### The seven rules of a great git commit message" still uses a fourth-level heading. Previous feedback suggested adjusting this to a third-level heading for consistent hierarchy. If a change was intended, please consider applying:-#### The seven rules of a great git commit message +### The seven rules of a great git commit message
40-44: Removal of URL Reference Guidelines
The guidelines for referencing documentation and source code files via relative and full URL paths (lines 40–44) have been removed. Please verify that this change is aligned with the overall documentation formatting objectives and that none of the essential reference instructions were inadvertently lost.docs/guides/webpack-configuration.md (1)
27-27: Enhance Clarity and Grammar in the Advantage StatementThe current sentence remains a bit wordy. As previously recommended, consider rephrasing it for improved clarity and conciseness. For example, you might update it as follows:
-The _advantage_ of using Shakapacker to configure Webpack is that there is very little code needed to get started, and you don't need to understand really anything about webpack customization. +The _advantage_ of using Shakapacker to configure Webpack is that very little code is needed to get started, and you don't need to understand anything about webpack customization.This small change not only tightens the language, but also enhances readability.
docs/javascript/capistrano-deployment.md (3)
3-3: Improved Clarity in Environment Description
The sentence now correctly states "the development environment," which improves clarity and aligns with standard grammar.
7-11: Proper Ruby Code Fence Formatting
The Ruby code block now uses "```ruby" (without an extra space), which ensures proper syntax highlighting and consistency with Prettier formatting expectations.
21-23: Consistent Ruby Code Block in Capfile Section
The Ruby code block for the Capfile is correctly formatted with "```ruby," ensuring uniformity and readability throughout the document.docs/api/view-helpers-api.md (11)
2-3: Heading Standardization Improvement:
The updated "## View Helpers API" heading now follows a consistent markdown structure, which improves the overall readability and clarity of the documentation.
7-8: Section Separation Enhancement:
The insertion of a horizontal rule (shown on line 7) establishes a clear visual break between the introductory content and subsequent sections. This aids users in quickly identifying distinct content areas.
18-19: Options Section Formatting:
The spacing refinement immediately after "Uncommonly used options:" (lines 18–19) helps to delineate the section and ensures consistent formatting throughout the document.
42-43: Improved Section Demarcation:
The added horizontal rule around line 42 provides a clear separation between the previous code block and the "react_component_hash" section. This visual divider supports a more organized layout for the reader.
81-82: Clear Section Transition:
The horizontal rule inserted after the JavaScript example (line 81) enhances the structure of the document by clearly signposting the start of a new section.
84-85: Enhanced Spacing Before Fragment Caching Section:
The additional line (line 84) before the "Fragment caching" section improves readability by providing adequate spacing, which helps signal a transition to a new topic.
95-97: Visual Separation in Cached Component Section:
The horizontal rule added between lines 95 and 97 effectively separates the "cached_react_component" details from adjacent content, contributing to clearer document navigation.
102-103: Consistent Section Break for Rails Context:
The horizontal rule created around line 102 maintains consistency in section breaks, ensuring that the "rails_context" section is clearly segregated from neighboring sections.
112-113: Section Divider for Renderer Functions:
The inclusion of a horizontal rule near line 112 neatly segments the Renderer Functions discussion from subsequent content, thereby enhancing overall document organization.
122-123: Clear Demarcation for React Router Section:
The horizontal rule following the "React Router" details (line 122) further delineates content areas, which supports better visual hierarchy in the documentation.
133-134: Final Section Separator:
The horizontal rule near the end of the document (line 133) reinforces the logical flow by cleanly separating concluding details from prior content.docs/guides/render-functions-and-railscontext.md (7)
1-1: Header Formatting Updated:
The main header (“# Render-Functions and the Rails Context”) is now clearly defined. This update improves clarity and consistency across the document.
24-25: Component Definition Formatting:
Splitting the arrow function definition forMyAppComponentover two lines (with the parameters on a new line) enhances readability by clearly delineating the function signature.
28-36: Inner Function & JSX Formatting:
The inner arrow function that returns the JSX element is now properly separated and indented. This clear separation improves readability and makes the component’s structure easier to understand.
45-54: Alternate API Formatting:
The alternate API example usingReact.createElementhas been reformatted for clarity. The arrow function and its JSX block are now laid out consistently, which improves the overall readability of the code sample.
128-137: JSX Component Default Export Formatting:
The default export component is now wrapped in an inner arrow function that returns JSX. The formatting at line 132—with the<br />tag—is clearer, and the overall structure now better conveys the intended component logic. Please ensure that the closure on line 137 matches your intended structure.
143-152: Higher Order Component Formatting:
The formatting updates forAppComponentWithRailsContext(including the multi-line function signature and immediate return of the React element) enhance clarity and align with modern React practices.
157-157: JSX Spread Operator Usage:
The use of the nested spread operators in<AppComponent {...{ ...props, railsContext }} />is formatted correctly. Verify that this merging strategy exactly meets your data propagation requirements.docs/guides/how-to-use-different-files-for-client-and-server-rendering.md (5)
14-14: Consistent semicolon usage in client entry example
Adding the semicolon toReactOnRails.register({ App });aligns the snippet with standard JavaScript formatting practices and the updated Prettier configuration.
22-22: Consistent semicolon usage in server entry example
The inclusion of a semicolon here ensures consistency with the client entry example and Prettier’s formatting rules, reducing potential issues with automatic semicolon insertion.
28-28: Enhanced reference to Webpack documentation
Introducing the reference "Per Webpack Docs" immediately provides readers with context and a reliable external resource. Please ensure that the link is maintained over time.
61-61: Improved code snippet formatting for webpack resolution update
The formatting change before the code sample in thewebpack/set-resolve.jsexample increases readability. Verify that the rest of the snippet (following this line) also conforms to your formatting standards.
98-98: Consistent visual separation in code block
The inserted blank or adjusted line at line 98 improves visual separation within the code block, enhancing readability without altering functionality.docs/javascript/server-rendering-tips.md (3)
22-24: CSS Section Formatting Update
The minor spacing adjustments before the "CSS" header and its content improve the document’s readability and align with the updated Prettier configuration.
31-34: Consistent Formatting in Example Code Block
The adjustments in the code block (lines 31–34) improve consistency and readability of the example. The changes appear purely cosmetic and are in line with the overall formatting improvements.
1-57: Overall Document Formatting Consistency
The applied changes are cosmetic—improving spacing and layout in alignment with the updated Prettier settings. No semantic content has been altered, and the document now reads more consistently across sections.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Your code can't referencedocument. Server side JS execution does not have access to `d...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...the view helper applies to client and server side code, the best way to do this is to use...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~14-~14: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...int is that you have separate files for top level client or server side, and you pass som...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~19-~19: A comma might be missing here.
Context: ...## Troubleshooting Server Rendering 1. First be sure your code works with server ren...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~20-~20: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...ou will also get the whole file used to setup the JavaScript context. ## CSS Server...(NOUN_VERB_CONFUSION)
docs/guides/i18n.md (7)
7-10: Enhanced Ruby Code Block forconfig.i18n_dir
The code snippet is now formatted with a proper Ruby code block using triple-backticks and clear indentation. Ensure the placeholder paths are updated in your environment as needed.
12-18: Clear and Consistent Formatting for YAML Directory Configuration
The Ruby code block for settingconfig.i18n_yml_diris now well formatted and visually consistent with the rest of the document. This improves readability for users configuring their internationalization settings.
24-27: Improved Clarity for Startup and CI Instructions
The instructions for adjusting startup scripts and CI configurations (lines 24, 26–27) are now clearly separated and more readable. This change helps ensure that users know when to run the rake task for locale generation.
37-40: Consistent Presentation for YAML Safe Load Options
The code block presentingconfig.i18n_yml_safe_load_optionsis now formatted consistently with the rest of the document. This clear presentation aids users in quickly spotting the configuration pattern.
52-59: Well-Formatted JavaScript Snippet for Package Dependencies
The JSON snippet outlining the dependencies forreact-intlandintlis clear, concise, and formatted correctly.
63-83: Comprehensive React Initialization Example
The JavaScript code snippet demonstrating the import and initialization ofreact-intlis now well organized. It clearly shows the use ofaddLocaleDataand the setup forIntlProvider. Ensure that these examples remain current with your project's version ofreact-intl.
85-93: Clear Component-Level Usage Example
The snippet for usingdefaultMessageswithin a component is formatted correctly and illustrates the intended usage succinctly.docs/guides/file-system-based-automated-bundle-generation.md (8)
7-9: Formatting Improvement: Header Spacing
The extra line break following "### Enable nested_entries for Shakapacker" helps to visually separate the header from the instructional text, enhancing readability. Please ensure similar heading sections across the document follow this consistent spacing approach.
21-23: Clarification in Components Subdirectory Description
The added description forcomponents_subdirectoryclearly explains its role in automatically registering components. This extra context benefits the reader and maintains consistency with other configuration sections.
41-47: Improved Formatting for Location of Generated Files
The bullet-point list detailing where generated files are placed is now reformatted for clarity. The use of dashes makes the information more digestible. Please double-check that the directory paths (using{Shakapacker.config.source_entry_path}and{Pathname(Shakapacker.config.source_entry_path).parent}) accurately reflect the current configuration.
48-52: Clearer .gitignore Update Instructions
The instructions to update the.gitignoreeffectively articulate which files should be ignored (i.e. generated files). This clarification mitigates accidental commits and is a good formatting improvement.
57-66: Enhanced Instructions for Server Bundle Entrypoint
The revised section that explains the import statement added to an existing server bundle entrypoint—including the corresponding code block—provides clearer guidance on necessary version control practices. This update reduces ambiguity and helps prevent integration errors.
72-76: Improved Background Section Formatting
The formatting adjustments in the "Background" section (as seen around line 73) provide better separation and readability. This makes the prerequisite configuration details easier to follow.
154-159: Updated Layout Example for Automated Bundle Generation
The ERB code block illustrating the updated layout now stands out more clearly, which improves comprehension of how to modify the Rails view. The clarity of this example helps ensure that developers can correctly apply the automated bundle generation feature.
182-187: Consistent ERB Code Block Formatting
The updated ERB snippet clearly demonstrates the usage ofappend_javascript_packalongsidereact_component, making the example easy to follow and consistent with the document’s overall formatting improvements.KUDOS.md (8)
13-15: Consistent Heading Format for June 9, 2017
The heading "## June 9, 2017" is formatted correctly and fits well within the timeline structure. Please ensure that similar entries continue to use the same header style.
19-21: Consistent Heading Format for May 6, 2017
The updated heading "### May 6, 2017" appears clear and consistent with the surrounding timeline entries.
25-27: Heading Format for April 6, 2017
The "### April 6, 2017" entry is correctly formatted. Make sure that its style aligns with other similar date headings throughout the document.
31-33: Standardized Heading for March 23, 2017
The heading "### March 23, 2017" now matches the overall formatting guidelines. No issues were detected here.
37-39: Consistent Formatting for March 21, 2017
The "### March 21, 2017" header is on par with the other timeline entries. Please double-check that all date headings follow the same header level.
89-92: Updated Entry for May 11, 2016
The "### May 11, 2016" entry—including its heading and the associated image lines—is well formatted. Verify that the images render properly and that the entry remains in the proper chronological order.
96-98: Consistent Heading for May 10, 2016
The heading "### May 10, 2016" appears correctly updated according to the Prettier formatting. No further changes are needed.
104-106: Consistent Formatting for March 25, 2016
The "### March 25, 2016" header is formatted in line with the document’s style. Ensure that the text following the header remains consistent with similar entries.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
106-106: Bare URL used
null(MD034, no-bare-urls)
PROJECTS.md (5)
3-3: New External Link Addition.
The newly added link on line 3 provides a direct search for public sites using React on Rails. It’s a useful addition to help users quickly locate examples.
30-38: Visual Elements and Extended Content.
The inclusion of images and additional details for individual products (lines 30–38) is well formatted and consistent with the list style. No further changes needed here.
40-44: Open Source Projects Section Reformatting.
The "Open Source Projects Live" section has been reformatted in line with the updated document style. The list items are clear and consistent.🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...lational Marketing for Real Estate. ## Open Source Projects Live - [github.com/empirical-...(EN_COMPOUND_ADJECTIVE_INTERNAL)
46-51: Demos and Tutorials Section Consistency.
The updates in the "Demos and Tutorials" section (lines 46–51) maintain the new formatting style and improve readability. Everything looks consistent.
52-55: Section Separation Improvement.
The horizontal rule at line 54 effectively separates the preceding content from what follows. The "Per Github." section is now clearly demarcated.docs/misc/doctrine.md (7)
35-37: Improved Separation in "The Menu Is Omakase" SectionThe formatting update around the section header and the introductory line (line 36–37) creates a clearer visual break and improves overall document flow.
39-46: "Libraries" Section List FormattingThe bullet points under the "Libraries" header (lines 39–46) have been reformatted. The updated style is consistent with Prettier’s guidelines and improves readability.
47-52: Enhanced "JavaScript Tooling" SectionThe list changes (lines 48–52) now provide a cleaner, more uniform presentation of the tooling options. Ensure that this format is consistent with similar list styles elsewhere in the documentation.
55-56: Minor Formatting Tweak in Adjacent CommentaryThe slight formatting adjustment in the “By the way, we're not omakase…” remark (line 55) improves clarity. No content changes observed.
57-60: Clarity in "No One Paradigm" SectionThe modifications in lines 58–59 enhance the section’s visual flow. The phrasing remains clear and true to the intended message.
81-84: Clear Formatting in "Raise a Big Tent" SectionThe section now benefits from improved spacing and visual clarity. The update is consistent with the overall document formatting improvements.
85-88: Enhanced Clarity in the "Thanks!" SectionThe closing section has been reformatted to improve readability and maintain a friendly tone. No content changes are needed.
docs/javascript/react-helmet.md (13)
4-4: Whitespace Enhancement in Installation Section
The additional blank line after the "## Installation and general usage" heading improves visual separation and readability.
9-9: Improved Separation in the Example Section
The extra spacing after the "## Example" heading provides a clearer distinction between sections.
12-12: Clarified Server Rendering Instruction
The newly added instruction “Create a render-function for server rendering like this:” makes the intended usage clearer for readers.
26-26: Better Visual Separation After Code Block
The added space following the JavaScript code snippet enhances clarity by visually separating the example from subsequent text.
33-33: Refactored Functional Component Export
Changing the export to use an implicit return (export default (props) => <App {...props} />;) simplifies the syntax and aligns with Prettier’s formatting standards.
38-38: Enhanced Separation Before Render-Function Example
The adjusted spacing before the code snippet that demonstrates the render-function approach helps delineate the instructional text from the code example.
56-56: Clear Section Demarcation for ReactHelmet Component
The extra spacing preceding the example that integrates the<Helmet>component contributes to a more readable and well-organized presentation.
71-71: Consistent Spacing After Code Block
The inserted blank line after the code snippet ensures consistency in layout and helps guide the reader through the documentation.
78-78: Trailing Comma Added for Consistency
Including a trailing comma in the object literal inside theReactOnRails.registercall promotes consistency with Prettier formatting and facilitates easier future modifications.
81-81: Consistent Formatting in Server Registration
The server-side registration section mirrors the client-side style well, ensuring uniformity across both examples.
90-90: Improved Separation After Registration Block
The additional spacing after the server registration code snippet creates a clear break between sections, aiding in overall document legibility.
94-94: Section Demarcation Before Ruby Snippet
The extra whitespace before the Ruby code example assists in visually segmenting different parts of the documentation for better clarity.
106-106: Enhanced Readability in Final Layout Section
Adding space before the Ruby code snippet that demonstrates layout insertion solidifies the document’s structured flow.docs/getting-started.md (7)
10-10: List Item Update – Adding a New Example Reference
The new list item at line 10 clearly provides an additional full-featured example reference. This improves the guidance for users exploring complete setups.
53-53: Node Runtime Environment Suggestion Added
The added note recommending theEXECJS_RUNTIME=Nodeenvironment variable helps clarify the requirements for users whose runtime setup may otherwise cause server rendering issues.
72-74: Clarification of Configuration Options
The revised bullet list detailing configuration for ReactOnRails and Shakapacker is clearer. Please verify that the adjustment—particularly the emphasis on the initializer versus the Shakapacker config—is intentional and aligns with the overall setup instructions.
116-116: HTML Tag Formatting Improvement
Changing<br/>to<br />adheres to consistent HTML formatting conventions and the updated Prettier rules.
183-190: JavaScript Object Literal Syntax Corrected
The example object forreact_component_hashnow correctly uses commas between properties instead of a semicolon. This update resolves the earlier syntax issue noted in past reviews.
196-198: Enhanced Error Handling Explanation
The updated error handling notes clarify that all errors are of typeReactOnRails::Errorand that prerendering errors include context details for debugging tools like HoneyBadger and Sentry. This extra detail is helpful for debugging.
201-202: Improved I18n Documentation
The addition at line 201 outlining the automatic conversion of Rails locale files into JSON/JS improves documentation clarity on internationalization support.docs/contributor-info/linters.md (4)
2-2: Improved Separation with Blank Line
The addition of the blank line at line 2 enhances the visual separation between the heading and the subsequent content, thereby improving the overall readability.
13-14: Rubocop Command Code Block Formatting
The code block for running RuboCop (rubocop -a) is well presented and instructive, aligning perfectly with the updated autofix instructions.
18-20: ESLint Autofix Command Update
The ESLint command is now correctly shown in its own code block using the--fixoption, which makes it clear that automatic fixes will be applied per the updated formatting approach.
24-26: NPM Lint Command Formatting
Displaying thenpm run lint -- --fixcommand in a dedicated code block ensures that contributors understand how to invoke ESLint autofixes via the npm script.docs/additional-details/recommended-project-structure.md (5)
18-18: Clear Section Heading for Conversion Steps.
The new heading clearly delineates the steps for converting from the generator defaults to a/clientdirectory, which improves navigation and overall clarity.
29-29: Updated Source Path Configuration.
The revised configuration line (source_path: client) aligns well with the new project structure and ensures consistency across the documentation.
36-44: Enhanced Node Module Setup Instructions.
The added step for creating a/package.jsonthat delegates to/client/package.json, along with the corresponding JSON snippet, provides clear guidance on reorganizing node modules. Please verify that these instructions are consistent with your overall project setup.
63-64: Verify Heading Consistency for Webpack Styling Section.
The "Using Webpack to Manage Styling Assets" section is clearly introduced. Ensure that its heading and subsequent content maintain consistent stylistic conventions with the rest of the document.
72-73: Advantages Section Formatting.
The advantages of using Webpack for managing styles are well presented, making it easy for readers to understand the benefits.🧰 Tools
🪛 LanguageTool
[grammar] ~73-~73: A verb (‘be’ or ‘have’) is missing before the past participle.
Context: ...es), which is super compelling once you seen the benefits. 1. You can use CSS in JS....(PRP_PAST_PART)
docs/javascript/react-router.md (5)
10-11: Consistent Import Formatting
The import statements now include semicolons and are formatted consistently per Prettier’s rules. No issues were noted here.
16-16: Ensure Store Initialization is Defined
The lineconst store = createStore(props);assumes thatcreateStorehas been imported (e.g. from Redux) or defined elsewhere in the module. Please verify that it is correctly imported to prevent a ReferenceError.
20-20: Clean JSX for Route Rendering
The JSX element<Switch>{routes}</Switch>is now compact and clear. The formatting update improves readability.
29-33: Improved Bullet List Formatting
The bullet items with links to the tutorial code have been reformatted for consistency. Ensure these external links remain up-to-date, but the formatting change itself looks good.
74-74: Validate Redirection Functionality
The callredirect(301, context.url);assumes that aredirectfunction is available in scope. Please ensure that it is defined or imported appropriately. If this snippet is meant as pseudocode for explanatory purposes, consider clarifying that in the documentation.spec/dummy/README.md (4)
3-4: Removed Setup Instructions – Formatting Only
The removal of the lines suggesting to use'yalc link'and to install yarn dependencies inspec/dummy/clientis a pure formatting change. Ensure that these removals reflect your current setup instructions.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e spec/dummy/client/node_modules to the top level - Be sure to install yarn dependencies ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
25-25: Command Formatting Consistency
The commandyarn run dummy:installis now clearly formatted. Please verify that this change is aligned with the updated workflow across the repo.
39-39: Static Assets Loading Section Formatting
The fenced code block for starting the static loading of Rails assets appears correctly restructured. No further changes are needed.
44-44: Test Assets Creation Block Clarity
The formatting of the code block to create assets for tests is clear and consistent with the document’s overall style.spec/dummy/client/README.md (2)
3-4: Consistent Header for ESLint Section
Changing the header to “# ESLint” brings consistency to the document’s styling.
51-55: Alternative Command Presentation is Clear
The alternative command block for adding node modules is well formatted and includes thebashspecifier.README.md (8)
21-23: News Section Bullet Points Reformatted
The bullet points under the “News” section have been reformatted for improved readability and visual consistency.
25-27: Updated Horizontal Rule & Version Note
Replacing the horizontal rule with a line of dashes and adding an italicized note for documentation versions creates a cleaner separation between sections.
31-34: About Section Streamlining
The “About” section changes introduce a more concise description of React on Rails and its maintenance. These updates enhance clarity.
46-47: React on Rails Pro Section Clarity
The updated introduction to React on Rails Pro—highlighting key features and providing direct links—is clear and effective.
67-67: Improved List Indentation
The indentation of the bullet point regarding “Tight integration with [shakapacker]…” now better aligns with the numbered list, aiding readability.
79-80: Online Demo Section Update
The bullet points in the “Online demo” section are now well formatted, clearly conveying the examples provided.
100-101: NEWS.md Link Emphasis
The update that highlights a reference to [NEWS.md] improves clarity about where to find ongoing project notes.
108-109: Work With Us Section Enhancement
The “Work with Us” section now stands out with a more prominent call-to-action, making it inviting for contributions or inquiries.docs/home.md (3)
4-4: Enhanced Spacing for Details Section
The additional blank line after “## Details” improves the document’s readability by clearly separating the heading and its content.
14-14: Consistent Spacing in Changes Section
Similarly, the added blank line after “## Changes and Upgrades” ensures better visual separation between headers and content.
26-26: Balanced Spacing in Other Resources Section
The spacing after the “Other Resources” header now creates a pleasing visual break and enhances overall readability.docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (12)
9-11: Clarify Deprecation Notice for Hot Reloading
The change in line 9 now clearly indicates that the olderreact-hot-loaderis deprecated in favor of the modern Fast Refresh approach. The text is now better aligned with current best practices.🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...efresh). For use with webpack, see **Client Side rendering and HMR using react-refresh-w...(EN_COMPOUND_ADJECTIVE_INTERNAL)
13-14: Enhanced Emphasis on Non–Server-Side Rendering
The updated formatting using not (in both occurrences) reinforces the condition and makes the intended behavior clearer. Please ensure consistency with similar documentation sections.
21-23: Improved Section Header and Break for Server/Client Bundles
Reformatting the “rendering.” text on line 21–22 and introducing the header in line 23 enhances the document’s structure and helps readers quickly locate the relevant section.
25-28: Clarify Configuration Reference for SSR
The note now emphasizes the configuration file (config/initializers/react_on_rails.rb) more clearly. It may be worthwhile to expand on what setting is expected, but the current change certainly improves clarity.
32-35: Consistent Documentation for Dev Server Settings
By explicitly mapping bothdev_server.hmranddev_server.inlineto their corresponding webpack-dev-server options, the instructions become more precise and easier to follow.
40-42: Improved Error Message Listing
The bullet-point list for potential error messages now uses a consistent style. This makes it easier for users to scan and understand the issues that may arise with misconfigurations.
43-48: Enhanced Client-Side Rendering Section Heading
Reformatting the header and updating the introductory sentence clarifies that HMR requires the use of./bin/shakapacker-dev-server. This aids in quick comprehension of the setup instructions.
49-60: Consistent YAML Code Block Formatting
The YAML snippet is now uniformly indented with clear formatting, which improves readability and reduces the chance of misinterpretation when users configure theirconfig/shakapacker.yml.
62-67: Clear Installation Instructions for React Refresh Packages
The instructions for adding the@pmmmwh/react-refresh-webpack-pluginandreact-refreshpackages are now well formatted within a bash code block, which helps maintain consistency with the rest of the document.
68-86: Improved JavaScript Snippet for Dev Server Integration
The JavaScript code snippet now clearly demonstrates how to conditionally append theReactRefreshWebpackPluginby extractingdevServerand checking for the webpack-dev-server environment. The inline configuration (e.g. settingoverlay.sockPort) is neatly integrated.
92-98: Clear Babel Configuration for React Refresh
The Babel configuration snippet is clearly presented. Using a conditional filter to include'react-refresh/babel'only when needed is both concise and effective.
105-117: Consolidated List of Tested Configurations
The concluding list of environments and versions is now well formatted. A quick check to ensure that terms (e.g., "babel" vs. "Babel") are consistently capitalized and punctuated could further enhance readability.docs/guides/tutorial.md (18)
3-3: Enhanced Introductory Text Formatting
The italicized text for the example repository link improves visual emphasis and aligns with the intended formatting updates.
5-5: Horizontal Rule for Section Separation
Adding the horizontal rule helps clearly divide the introductory content, reinforcing section demarcation.
7-7: Updated Version Information
The italicized note now clearly communicates the updated versions for Ruby, Rails, React on Rails, and Shakapacker, enhancing clarity.
16-18: Consistent Link List Formatting
The revised bullet list under “You can find it here:” now uniformly presents the source code and live app links. Please verify that these links remain valid.
22-23: Uniform External Link Formatting
The external links for the RubyGems and npm pages are now formatted with angle brackets, ensuring consistency across the document.
26-26: Improved Visual Separation
The additional blank line (or subtle adjustment) aids in separating the Table of Contents from preceding content, improving overall readability.
44-44: Consistent Section Spacing
The spacing adjustments around the section headers help maintain a clean and organized layout throughout the document.
45-46: Section Heading Emphasis
The “Installation” heading is now more prominent due to improved spacing, which enhances the document’s structure.
57-59: Clarified Rails Application Setup Instructions
The updated instructions for creating a fresh Rails application are clearer and more direct, which benefits readers new to the setup.
76-77: Gem Version Recommendation Clarity
The formatting adjustments in the “Add the Shakapacker and react_on_rails gems” section enhance readability and reinforce the guidance on version specifications.
151-153: Heroku Login Reminder Enhancement
The italicized note prompting users to confirm their Heroku login status is a useful contextual addition.
172-173: Emphasis on Postgresql Requirement
The updated phrasing clearly states that Heroku requires Postgresql, adding clarity for users who need to adjust their app settings accordingly.
246-262: Puma Configuration Code Block Formatting
The Puma configuration snippet is now better formatted, making it easier for users to parse the settings and understand how to configure the server.
316-328: Improved Server Rendering HTML Markup
The re-indented HTML block for server rendering is significantly clearer. The structure now more visibly reflects the nested elements.
333-334: Refined Documentation Resource Links
The bullet list for “Client vs. Server Rendering” and “React Server Rendering” now provides a neat and consistent presentation of documentation links.
360-362: Enhanced Resource Link List for HMR Topics
The reformatted list containing the webpack-dev-server, DevServer, and Hot Module Replacement links is clear and user-friendly.
380-382: RubyMine Performance Tip Formatting
The updated bullet list under the RubyMine performance tip clearly identifies directories (e.g., generated packs and node_modules) to exclude, aiding in optimal IDE performance.
385-386: Conclusion Section Formatting
The concluding section now cleanly presents an external documentation link, rounding off the guide with a clear call-to-action.CONTRIBUTING.md (24)
3-5: Formatting and Link Consistency in Contributor Tips
The adjustment of bullet points in these lines improves readability. Please double-check that no essential contributor link (for example, the releasing instructions) has been inadvertently removed.
8-11: Enhanced Readability in Test Instructions Section
The insertion of blank lines and the restructured bullet points make the “To run tests” section much clearer.
24-34: IDE/IDE Setup Bullet List Formatting
The list of directories to ignore is well formatted and clearly delineated, making it easier for contributors to set up their development environment.
37-38: Clear Section Separation for Local Fork Configuration
The additional spacing before the “Configuring your test app to use your local fork” instructions improves the flow of the document.
48-56: Improved Structure in 'Testing the Ruby Gem' Section
The enhanced spacing and formatting in this section add clarity to the instructions for testing the Ruby parts of the gem. Please verify that the Gemfile path example remains correct.
58-62: Enhanced Formatting in Node Package Testing Steps
The revised instructions for testing the node package (via Yalc) along with the clear code block improve guidance significantly.
70-78: Consistent Presentation of Yalc Publishing Steps
The code block outlining the yalc publishing process is clear and easy to follow. This consistency in formatting helps ensure contributors understand the sequential steps.🧰 Tools
🪛 LanguageTool
[style] ~70-~70: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...led files yarn run build-watchYou need to do this once:# Will send the upda...(REP_NEED_TO_VB)
104-108: Clear Example Instructions for NPM Testing
The example regarding testing NPM changes in the dummy app is well explained and provides step-by-step guidance.🧰 Tools
🪛 LanguageTool
[uncategorized] ~107-~107: Possible missing comma found.
Context: ...sh the browser if the server is already running or start the server using `foreman star...(AI_HYDRA_LEO_MISSING_COMMA)
113-116: Improved Clarity in Dev Initial Setup
The additional spacing and clear explanation regarding prerequisites and setup commands help make the initial development environment instructions more accessible.
121-122: Valuable Side Note for Webpack Alias Configuration
The side note emphasising the importance of using the webpack alias to prevent double inclusion is both informative and well positioned.
132-138: Consistent Formatting for NPM Dependency Installation
The code block that instructs on installing NPM dependencies and building the package is clear and consistent with the overall document formatting.
143-148: Clear Instructions for Running Dummy App Specs
The directions for optionally changing the Capybara driver and running the dummy specs enhance clarity for contributors who are setting up the test environment.
150-158: Detailed Instructions for Converting to Shakapacker v6
The step-by-step guide provided in this section is well formatted and clear, making it straightforward to follow the conversion process.
160-168: Improved Clarity in Test Running Instructions
The revised formatting for running JS tests—including well delineated code blocks—makes the instructions in this section more accessible and easier to follow.
169-175: Well-Formatted Spec/Dummy Test Instructions
The clear presentation of commands for running spec/dummy tests ensures that contributors can easily verify the test environment.
176-182: Clear Instructions for Combined Linting and Testing
The instructions for running lint, type checking, and JS tests in unison are clear and logically organized.
187-195: Well-Structured RSpec Testing Instructions
This section efficiently outlines the steps and potential pitfalls when running RSpec tests. The formatting is clear; please confirm that all instructions remain up-to-date with the current setup.
203-209: Clear Generator Installation Steps
The instructions for adding the gem to your Rails app—along with the clearly formatted code block—offer concise guidance on generator installation.🧰 Tools
🪛 LanguageTool
[uncategorized] ~205-~205: A comma might be missing here.
Context: .... ### Install Generator In your Rails app add this gem with a path to your fork. ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
213-214: Clear Instructions for Running the Main Installer
The brief note about runningrails generate react_on_rails:installis straightforward and clear.
239-241: Helpful Resource Links for Docker Setup
The added resource links for Docker Toolbox (Mac) and Docker Compose (Linux) are valuable for contributors, ensuring that all necessary tools are easily accessible.
245-256: Consistent Command Instructions for Linting
The variety of linting instructions, whether via directrakecommands or using Docker, is clearly laid out and helps guide contributors through multiple approaches.🧰 Tools
🪛 LanguageTool
[typographical] ~250-~250: Consider adding a comma here.
Context: ...rs. For individual rake linting commands please refer torake -D dockerfor the list....(PLEASE_COMMA)
257-262: Clear Instructions for Updating Rubocop
Listing the two files that require updating for the Rubocop version clarifies the scope of the change for maintainers.
263-270: Well-Structured Docker CI Instructions
The Docker CI and testing instructions are comprehensive and well formatted, ensuring that contributors can quickly understand how to build and run CI tests.
271-276: Informative Section for Maintainers and Contributors
The concluding section offers valuable insights and advice. The improved spacing and formatting enhance readability and provide a nice wrap-up for the document.🧰 Tools
🪛 LanguageTool
[grammar] ~275-~275: If this is a question, the word order is probably incorrect. Did you mean “Why is this”… ?
Context: ...ub.com/turbolinks/turbolinks) repo: > [Why this is not still fully merged?](https://github...(WHY_THE_WORD_ORDER_IS_WRONG)
docs/rails/turbolinks.md (10)
1-8: Header and PR reference formatting improves clarity.
The heading and bullet points (including the PR links on lines 4–7) have been reformatted for consistent presentation and easier scanning.
11-12: Enhanced inline code snippet for Turbo configuration.
The code snippetReactOnRails.setOptions({ turbo: true })is now clearly delineated with backticks, improving readability.🧰 Tools
🪛 LanguageTool
[typographical] ~11-~11: It seems that a comma is missing.
Context: ... obsolete. # Using Turbo To configure Turbo the following option can be set: `React...(IN_ORDER_TO_VB_COMMA)
20-23: Improved Legacy Turbolinks section formatting.
The Legacy Turbolinks section (lines 20–23) now clearly warns that these docs may be outdated and provides updated external links. The new emphasis helps set proper expectations.
48-59: Installation checklist formatting is clear and consistent.
The “Install Checklist” section (lines 48–59), including the embedded code block, is now formatted in a way that aligns with Prettier conventions.
65-70: Turbolinks 5 and NPM instructions are well-presented.
Both the header for Turbolinks 5 and the instructions for installing Turbolinks from NPM (including the code snippet on lines 76–77) are clearly formatted, providing straightforward guidance.Also applies to: 75-78
80-92: Async script loading guidance is improved.
The section on async script loading (lines 80–92) now includes a helpful workaround usingdeferfor the initial page load, along with clearly formatted code examples.
96-102: ReactOnRails page load re-initialization code is clear.
The code snippet that callsReactOnRails.reactOnRailsPageLoaded()(lines 96–102) is correctly formatted and clearly demonstrates the intended usage.
104-130: Troubleshooting and webpack configuration details are detailed and clear.
The instructions for enabling Turbolinks tracing and configuring webpack (lines 104–130) are thorough and formatted well. No issues were noted.
134-148: Console output examples for Turbolinks are well-formatted.
Both the Turbolinks Classic and Turbolinks 5 console message examples (lines 134–148) are clearly illustrated, aiding users in understanding expected debugging output.
150-153: Final notes and illustration are correctly formatted.
The concluding note regarding the use of jQuery packages (line 150) and the included image (line 152) round out the document nicely.🧰 Tools
🪛 LanguageTool
[uncategorized] ~150-~150: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...y gem version of jQuery and jQuery ujs. Therefore we recommend using the node packages in...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
docs/release-notes/15.0.0.md (2)
36-48: Update Usage Guidance for Async Hydration Function
The documentation now correctly illustrates thatReactOnRails.reactOnRailsPageLoaded()is asynchronous and must be awaited. The before-and-after code examples are clear and should help users update their implementations without confusion.
65-69: Review Store Dependencies Clarification
The explanation regarding store dependencies is well articulated—highlighting that components by default wait for all previously created stores. This clearly sets the stage for the solution provided later. No further changes are necessary, but if there’s room for additional examples or clarification, consider a brief note on best practices for declaring store dependencies.docs/guides/upgrading-react-on-rails.md (20)
4-5: Added Migration Support Contact Info
A new sentence has been added to offer users direct contact details for migration help and server rendering support. This addition is clear and useful for readers.
10-13: Clarify Breaking Change for Gem Dependency
The “Breaking Change” section now notes that thewebpackergem dependency has been superseded byshakapacker. This clarification is beneficial; please double-check that all related documentation elsewhere is updated consistently.
24-27: Improved Upgrading to v12 Section Title and Details
The section for upgrading to v12 now includes modified headings (lines marked with "~") along with clearer instructions regarding Rails and webpacker versions. This improves the guidance provided to users.
31-34: Explicit Removal of Deprecated Configuration
The change highlights the removal ofconfig.symlink_non_digested_assets_regexfrom the initializer. This explicit instruction helps developers remove outdated settings, which is appropriate for the upgrade process.
56-60: Clear Example for Functions Returning a React Element
The code snippet for functions that take zero or one parameter and return a React element is well presented. The formatting and content are clear.
88-90: Example for Updating to a React Function Component
The revised code snippet demonstrates how to wrap the returned JSX in a function, ensuring that a React function or class component is returned. This update is clear and well formatted.
103-107: Instructive Broken Example Warning
The example labeled “Broken” shows the pitfall of directly returning a JSX literal when two parameters are used. This example will be useful to developers in avoiding common mistakes.
127-127: Added Horizontal Rule for Section Separation
A horizontal rule has been added to improve visual separation between sections, which enhances document readability.
129-130: Minor Header Formatting Update for Webpacker Upgrade Section
The header for “Upgrading rails/webpacker from v3 to v4” now includes a minor formatting change. No content issues detected.
131-134: Clarification in Custom Webpack Build File Instructions
The text now more clearly explains that the defaultextract_cssvalue inconfig/webpack.ymlis false and should be set to true for custom builds. This clarification is useful.🧰 Tools
🪛 LanguageTool
[uncategorized] ~133-~133: Possible missing comma found.
Context: ...webpack builds should set this value to true or else no CSS link tags are generated....(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~133-~133: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...(https://github.com/rails/webpacker) to setup your Webpack configuration. ```yml def...(NOUN_VERB_CONFUSION)
135-140: Properly Formatted YAML Snippet for Webpack Config
The YAML code block now uses clear indentation and inline comments to show thatextract_cssshould be enabled. The snippet looks correct and is easy to read.
142-146: Updated Upgrade Instructions for Version 11
The upgrade guidance for v11 now instructs users to remove several deprecated configurations (e.g.,server_render_method, ENV variables, and utility methods). This helps streamline the migration; however, double-check for any backward‐compatibility notes needed for legacy users.🧰 Tools
🪛 LanguageTool
[uncategorized] ~144-~144: The preposition “by” seems more likely in this position.
Context: ..._RAILS"] usage. You can get all tracing with either specifyingtraceat your c...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~145-~145: Possible missing preposition found.
Context: ...des to enable component and other types caching with React on Rails. ## Upgrading to v...(AI_HYDRA_LEO_MISSING_OF)
🪛 markdownlint-cli2 (0.17.2)
143-143: Bare URL used
null(MD034, no-bare-urls)
148-151: Concise Upgrade Steps for Version 10
The brief instructions for upgrading to version 10 (including switching fromreact_componenttoreact_component_hash) are clear and to the point.
158-160: Clear Rationale for Integrating Webpacker
A brief explanation now states why bypassing the asset pipeline via Webpacker is beneficial. This additional context is appreciated.🧰 Tools
🪛 LanguageTool
[uncategorized] ~160-~160: Possible missing comma found.
Context: ...maps in production. This is 100% a best practice as source maps in production greatly in...(AI_HYDRA_LEO_MISSING_COMMA)
189-194: Updated List of Breaking Configuration Changes
The section now clearly enumerates breaking changes (including the newconfig.node_modules_locationoption and renamed commands). This structured list is very useful.
203-211: Renaming of WebpackConfigLoader Properties
The updated instructions for renaming properties (such aswebpackOutputPathtooutput.path) are well laid out. Ensure that these mappings are correct and that any related documentation or examples are updated accordingly.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
207-207: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
213-222: Updated Webpack Output Configuration Example
The diff now shows changes to the Webpack output settings (including using a hash-based filename for cache busting). This guidance is concise and beneficial.
223-229: Improved ManifestPlugin Configuration Example
The new snippet for configuring ManifestPlugin is clear and follows best practices. The code block is well formatted.🧰 Tools
🪛 LanguageTool
[grammar] ~225-~225: This phrase is duplicated. You should probably use “Run Run” only once.
Context: ...rade RoR in theclient/package.json- Runbundle- Runrails webpacker:install- Runrails webpacker:install:react- Runrails g react_on_rails:install- Move...(PHRASE_REPETITION)
231-253: Enhanced Instructions for Renaming and Configuring webpacker_lite.yml
The section provides step-by-step guidance on renamingwebpacker_lite.ymltowebpacker.ymland adjusting related settings, including production and development configurations. Verify that all URLs and references are still valid.🧰 Tools
🪛 LanguageTool
[style] ~242-~242: This phrase is redundant. Consider using “inside”.
Context: ...toconfig/initializers/react_on_rails.rbto keep your node_modules inside of/client2. Renamed - config.npm_b...(OUTSIDE_OF)
260-266: Streamlined Guidance for Non-Webpacker Integrations
The instructions for projects that do not integrate webpacker are concise and clear, outlining the necessary command renames and configuration additions.docs/outdated/rails-assets-relative-paths.md (12)
1-1: Doc Header Formatting Updated
The introductory note on line 1 now follows the updated Prettier formatting rules. This change is purely stylistic and does not affect content.
40-41: Consistent String Delimiters in Loader Configuration
The loader configuration now uses single quotes (e.g., inloader: 'file-loader?name=[name].[ext]',) to conform with the updated Prettier rules.
47-47: Formatted Loader Option Name Property
Thenameproperty in the loader example is now enclosed in single quotes, ensuring style consistency.
55-57: Alias Configuration Formatting
The alias definition ('assets': path.resolve('./app/assets'),) now uses single quotes and proper indentation as enforced by Prettier.
63-65: Consistent Naming Format in Query Parameters
The snippet setting the file naming pattern (name: '[name][md5:hash].[ext]',) now reflects the updated formatting guidelines using single quotes.
72-72: Formatting Consistency for Output Path
TheoutputPathproperty now uses single quotes ('webpack-assets/'), aligning with the overall formatting updates.
84-84: Consistent Public Path Formatting
ThepublicPathstring is now formatted with single quotes as per the updated Prettier configuration.
136-136: Webpack Entry Configuration Format
Theentryproperty in the webpack configuration has been reformatted to match the updated style guidelines.
138-141: Formatted Webpack Output Path
The output configuration, notably thepathproperty ('../app/assets/webpack'), has been reformatted to enhance clarity and adhere to the Prettier style.
155-157: Proper Object Literal Formatting in DefinePlugin
The object literal within theDefinePluginconfiguration now has improved alignment and readability due to the updated formatting.
171-174: Refined Imports Loader Options Formatting
The closing bracket and indentation for theimports-loaderoptions have been adjusted, resulting in a cleaner and more consistent code block.
182-186: Consistent File-loader Options Formatting
The properties within the file-loader configuration (includingpublicPath) are now uniformly wrapped in single quotes and properly indented. This improves readability and adheres to the new Prettier standards.NEWS.md (32)
3-3: Improved Intro Formatting
The introductory text now uses italic formatting, which enhances readability and matches the intended style.
5-6: Bullet Entry Formatting for October 14, 2020
The date is emphasized in bold and the link is intact. This change clearly delineates the entry.
11-11: Bullet Entry for July 8, 2020 Release
The release entry now presents “Release v12” in a clear and concise manner.
16-18: Bullet Entries for Late 2017 and CHANGELOG Reminder
The formatting for the entries on 2018-02-27, 2017-09-06, and the reminder to consult the CHANGELOG is now consistent and well spaced.
19-19: Bullet Entry for Version 8.1.0
The link and the descriptive text are formatted correctly, ensuring clarity.
20-20: Bullet Entry for 7.0.0 Shipped!
This entry clearly emphasizes performance improvements and the breaking change note.🧰 Tools
🪛 LanguageTool
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ...rformance improvements! Please upgrade! Only "breaking" change is that you have to u...(AI_EN_LECTOR_MISSING_DETERMINER)
21-21: Bullet Entry for 8.0.0 Beta Work
The updated entry concisely indicates that beta work has begun with the webpacker_lite gem.
22-22: Bullet Entry for 6.9.3 Released!
The release note now stands out with proper formatting, making it easy to read.
23-23: Bullet Entry for Webpack v2 Update
This entry is succinct and correctly formatted, highlighting the upgrade to Webpack v2.
24-24: Bullet Entry for Internationalization Demo
The bullet effectively introduces the internationalization (i18n) demo with a link to the documentation.
25-25: Bullet Entry for Webpacker Discussions
The description and corresponding link clearly direct readers to further discussions on Webpacker.
26-26: Bullet Entry for Upgrade Instructions Using Webpack v2 or --bail Option
The instructions are now clearly formatted.
27-27: Bullet Entry for 2016-11-03 LA Ruby Event (First Mention)
The entry is succinctly formatted and maintains consistency with other event entries.
28-28: Bullet Entry for 2016-12-20 Egghead.io Video
The link and descriptive text are clear, enhancing the entry’s informational value.
29-29: LA Ruby Event Date Consistency
This entry mentions “2016-11-03” alongside “Thursday, November 10”. Please verify that the day of the week and date are consistent (as flagged in a previous review).🧰 Tools
🪛 LanguageTool
[inconsistency] ~29-~29: Did you mean to refer to the current year? November 10, 2025 is not a Thursday, but a Monday.
Context: ...) - 2016-11-03: Spoke at [LA Ruby, 7pm, Thursday, November 10 in Venice, CA: "React on Rails: Why, Wh...(EN_DATE_WEEKDAY_CURRENTYEAR)
30-30: Bullet Entry for Documentation Gitbook Announcement
The entry is clear and brings attention to the availability of a new documentation resource.
31-31: Bullet Entry for v6.1 Release Note
The formatting here is consistent with other entries.
32-32: Bullet Entry for Server Rendering Recommendation
The tip regarding using mini_racer is clearly presented with an appropriate link for further details.
34-34: Duplicate Documentation Gitbook Entry
This appears to be a duplicate of the announcement on line 30. Please confirm if the duplication is intentional; if not, consider removing one of the entries to avoid redundancy.
35-35: Duplicate v6.1 Release Note
Similar to the previous comment, this duplicate entry should be reviewed to ensure it was intended.
36-36: Bullet Entry for 6.0.4 Release Critical Fix
The entry is clearly formatted and calls attention to the critical fix regarding the missing polyfill.
38-38: Bullet Entry for 6.0.0 Release
The release note is properly formatted with a clear reference to the CHANGELOG.
39-39: Bullet Entry for 5.2.0 Release
This entry clearly presents support for React 15.0 and the accompanying updates to the Generator.
40-40: Bullet Entry for Slides on React on Rails
The formatting and link are correctly maintained in this entry.
41-41: Bullet Entry for 4.0.3 Release
This entry is concise and communicates the new Heroku buildpack steps clearly.
42-42: Bullet Entry for 4.0.2 Release
The entry is succinct and maintains consistency with adjacent release announcements.
43-47: Sub-bullets for 4.0.2 Release Details
The indented sub-bullets detailing improvements (hot reloading, Turbolinks 5 support, etc.) are clearly structured and enhance readability.
49-49: Bullet Entry for 3.0.6 Shipped Notice
The entry is comprehensive and includes useful migration details.🧰 Tools
🪛 LanguageTool
[style] ~49-~49: Consider an alternative verb to strengthen your wording.
Context: ...md) for details, and let us know if you see any issues! [Migration steps from 1.x](...(IF_YOU_HAVE_THIS_PROBLEM)
50-51: Sub-bullets for 3.0.6 Details
Both sub-points referencing RubyGems and NPM are clearly delineated.
52-52: Bullet Entry for 3.0.0 Highlights
The header for the highlights is clear and correctly formatted.
57-57: Bullet Entry for 2.x Highlights
The entry is clear and matches the formatting style used throughout the file.
62-62: Bullet Entry for The React on Rails Doctrine Article
The entry is concise and effectively directs readers to the article.
| const html = ReactDOMServer.renderToString( | ||
| <Provider store={store}> | ||
| <StaticRouter location={location} context={context} props={props}> | ||
| <App /> | ||
| </StaticRouter> | ||
| </Provider>, | ||
| ); |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix Incorrect Call to Rendering Function
The code imports the named function renderToString from 'react-dom/server' (line 46) but later calls it as ReactDOMServer.renderToString(...) (line 64). This inconsistency is likely to cause a runtime error since ReactDOMServer isn’t defined. To fix this, either adjust the call to use the imported renderToString directly or change the import to bring in the entire module. For example, if you choose the former, apply this diff:
- const html = ReactDOMServer.renderToString(
+ const html = renderToString(📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const html = ReactDOMServer.renderToString( | |
| <Provider store={store}> | |
| <StaticRouter location={location} context={context} props={props}> | |
| <App /> | |
| </StaticRouter> | |
| </Provider>, | |
| ); | |
| const html = renderToString( | |
| <Provider store={store}> | |
| <StaticRouter location={location} context={context} props={props}> | |
| <App /> | |
| </StaticRouter> | |
| </Provider>, | |
| ); |
| - The `force_load` configuration make `react-on-rails` hydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load. | ||
| - If you want to keep the previous behavior, you can set `defer_generated_component_packs: true` or `force_load: false` in your `config/initializers/react_on_rails.rb` file. | ||
| - If we want to keep the original behavior of `force_load` for only one or more components, you can set `force_load: false` in the `react_component` helper or `force_load` configuration. | ||
| - Redux store support `force_load` option now and it uses `config.force_load` value as the default value. Which means that the redux store will hydrate immediately as soon as its server-side data reaches the client. You can override this behavior for individual redux stores by setting `force_load: false` in the `redux_store` helper. |
There was a problem hiding this comment.
Correct Grammatical and Clarity Issues in Configuration Descriptions
There are some grammatical and clarity issues in the description of the force_load configuration and Redux store support:
- In line 31, “The
force_loadconfiguration makereact-on-railshydrate components…” should use “makes” for proper subject–verb agreement. - In line 34, the phrasing “Redux store support
force_loadoption now and it usesconfig.force_loadvalue as the default value. Which means that the redux store will hydrate immediately…” is a bit awkward. Consider rephrasing for clarity and grammatical correctness. For example:
- - The `force_load` configuration make `react-on-rails` hydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load.
+ - The `force_load` configuration makes `react-on-rails` hydrate components immediately as soon as their server-rendered HTML reaches the client, without waiting for the full page load.- - Redux store support `force_load` option now and it uses `config.force_load` value as the default value. Which means that the redux store will hydrate immediately as soon as its server-side data reaches the client.
+ - Redux store support for the `force_load` option now uses `config.force_load` as its default, meaning that the Redux store will hydrate immediately as soon as its server-side data reaches the client.Addressing these will enhance readability and clarity.
Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ded. - The force_load configuration make react-on-rails hydrate components imm...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...hes the client, without waiting for the full page load. - If you want to keep the previ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...zers/react_on_rails.rbfile. - If we want to keep the original behavior offorce_lo...
(REP_WANT_TO_VB)
[uncategorized] ~34-~34: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ce_loadconfiguration. - Redux store supportforce_loadoption now and it usesco...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~34-~34: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ux store support force_load option now and it uses config.force_load value as th...
(COMMA_COMPOUND_SENTENCE)
alexeyr-ci
force-pushed
the
alexeyr/format-typescript
branch
from
de23424 to
403d323
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/javascript/react-router.md (1)
45-70:⚠️ Potential issueFix Incorrect Call to Rendering Function
The code imports the named functionrenderToStringfrom'react-dom/server'(line 46) but later calls it asReactDOMServer.renderToString(...)(line 64). Please update the call to userenderToString(...)directly. For example:- const html = ReactDOMServer.renderToString( + const html = renderToString(This change ensures consistency with the import and avoids potential runtime errors.
🧹 Nitpick comments (61)
docs/deployment/elastic-beanstalk.md (1)
45-47: Ensure Consistent Capitalization and Readability in Deployment Instructions
The newly formatted lines provide clarifying context, but please consider capitalizing proper nouns for consistency. For example, change "react app javascript files" to "React app JavaScript files" for improved clarity.🧰 Tools
🪛 LanguageTool
[grammar] ~47-~47: “React” is a proper noun and needs to be capitalized.
Context: ...ic beanstalk successfully. However, the react app javascript files are under `public/...(A_GOOGLE)
docs/outdated/rails-assets.md (1)
8-9: Minor Grammar Suggestion: Add Comma for Clarity
The block quote beginning with "By default the filename of the resulting file is..." would benefit from a comma after "By default" as suggested by LanguageTool.
For example:By default, the filename of the resulting file is the MD5 hash...
🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: Did you mean: “By default,”?
Context: ...e other term for this is a "digest". > By default the filename of the resulting file is t...(BY_DEFAULT_COMMA)
docs/testimonials/resortpass.md (1)
3-3: Refine Wording and Capitalization in Testimonial
The merge of paragraphs has streamlined the testimonial, but note that within the text "react on rails" should be corrected to "React on Rails" (as React is a proper noun) and consider using a more impactful adjective than "sophisticated" to further emphasize the technical excellence.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Consider an alternative adjective to strengthen your wording.
Context: ...ted code that both works and reflects a deep understanding of the technologies and p...(DEEP_PROFOUND)
[grammar] ~3-~3: “React” is a proper noun and needs to be capitalized.
Context: ...s and standards for our transition to a react on rails application. Just three months...(A_GOOGLE)
docs/outdated/rails3.md (1)
3-5: Enhance Clarity in Rails 3 Support Notes
The removal of bullet formatting changes the presentation. Consider rephrasing these lines for a stronger call-to-action. For example, you might update the statements as follows:
- Instead of:
- Please let us know if you find any issues with Rails 3.
Use:
If you encounter any issues with Rails 3, please report them via an issue or submit a pull request.- Instead of:
- We are not testing it for new releases. If you find an issue, you will have to submit a PR to get it fixed.
Use:
Note: Rails 3 is not actively tested against new releases. If an issue arises, please consider submitting a pull request to address it.
These minor wording enhancements can make the instructions more direct and engaging.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: Consider using a different verb to strengthen your wording.
Context: # Rails 3 - Please let us know if you find any issues with Rails 3. - Rails 3 is c...(FIND_ENCOUNTER)
[style] ~5-~5: Consider using a different verb to strengthen your wording.
Context: ...not testing it for new releases. If you find an issue, you will have to submit a PR ...(FIND_ENCOUNTER)
docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md (1)
10-10: Convert Bare URL to Markdown Link for Improved Readability
Line 10 contains a bare URL. For better markdown style and clarity, consider converting it to a markdown link. For example, update:https://github.com/shakacode/shakapacker/tree/master/lib/install/binto something like:
[Latest shakapacker binary installation instructions](https://github.com/shakacode/shakapacker/tree/master/lib/install/bin)This change enhances both readability and navigability.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
10-10: Bare URL used
null(MD034, no-bare-urls)
CONTRIBUTING.md (2)
7-7: Remove Trailing Punctuation in Heading
The heading “## To run tests:” uses a trailing colon. Removing it (to “## To run tests”) will help comply with common Markdown style guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
7-7: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
22-22: Insert a Comma for Clarity
In the sentence “It's critical to configure your IDE/editor to ignore certain directories. Otherwise your IDE might slow to a crawl!” consider adding a comma after “Otherwise” to improve readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...E/editor to ignore certain directories. Otherwise your IDE might slow to a crawl! - /cov...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
docs/javascript/foreman-issues.md (1)
11-12: Enhance Clarity in Issue Description
The bullet point describing the failure ofreact-s3-uploaderwould benefit from improved wording. For example, changing “was failing to finish upload file to S3” to “was failing to finish uploading the file to S3” (or similar) improves clarity by adding the definite article “the”.🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...ailing to finish upload file to S3 when server was started by `foreman -f Procfile.dev...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/javascript/angular-js-integration-migration.md (1)
7-7: Refine Wording for Clarity
In the sentence “...then you can setup theReactOnRailsdefault JS code directory…” consider changing “setup” to “set up” (verb form) and revising “no different than” to “no different from” for improved formality and clarity.🧰 Tools
🪛 LanguageTool
[grammar] ~7-~7: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ave not already done this, then you can setup theReactOnRailsdefault JS code dire...(NOUN_VERB_CONFUSION)
[style] ~7-~7: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style.
Context: ...inclusion this way will be no different than using the Rails asset pipeline. However...(DIFFERENT_THAN)
docs/additional-details/manual-installation-overview.md (1)
22-22: Improve Grammar in Rails Steps Section
In the Rails Steps section, consider revising the sentence to:
“The gem provides thestylesheet_pack_tagandjavascript_pack_taghelpers, which are used to load the bundled assets into your layouts.”
This change adds a needed comma and corrects “is” to “are” for grammatical consistency.🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...eet_pack_tagandjavascript_pack_tag` helpers which is used to load the bundled asset...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...andjavascript_pack_taghelpers which is used to load the bundled assets to your...(AI_HYDRA_LEO_CPT_IS_ARE)
README.md (1)
87-87: Refine Infinitive Construction to Avoid Split Infinitives
In the bullet point “How to conditionally render server side based on the device type”, the adverb “conditionally” splits the infinitive “to render.” Consider rephrasing it to, for example, “How to render server side conditionally based on the device type” to improve clarity and avoid split infinitives.🧰 Tools
🪛 LanguageTool
[style] ~87-~87: Style-wise, it’s not ideal to insert an adverb (‘conditionally’) in the middle of an infinitive construction (‘to render’). Try moving the adverb to avoid split infinitives.
Context: ...lient-and-server-rendering/1352) - [How to conditionally render server side based on the device type](https://forum...(SPLIT_INFINITIVE)
docs/javascript/webpack-v1-notes.md (1)
7-7: Tone and Punctuation Refinement in Webpack Bail Option Description
The newly added sentence clearly explains the use of the--bailoption; however, consider reducing the number of exclamation marks and adding a comma before “and” in the clause for a slightly more formal tone.🧰 Tools
🪛 LanguageTool
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1166 characters long)
Context: ...ment halt if Webpack cannot complete! For more details, see the documentation...(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~7-~7: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Webpack returning a non-zero error code and you want to see all the errors, rather ...(COMMA_COMPOUND_SENTENCE)
docs/home.md (1)
22-22: Consistent Verb Usage for Clarity
In the phrase “a new way to setup the creation of your SSR bundle,” consider using the verb form “set up” instead of “setup” to improve grammatical clarity.🧰 Tools
🪛 LanguageTool
[grammar] ~22-~22: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `s...(NOUN_VERB_CONFUSION)
docs/guides/how-react-on-rails-works.md (1)
5-5: Enhanced Explanation of Webpack Bundles and Shakapacker Integration
The new paragraph detailing how Webpack bundles are generated directly to/publicimproves clarity. For consistent markdown emphasis, consider replacing the underscores in recommended with asterisks (i.e. recommended) as suggested by markdown linting guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
5-5: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
docs/misc/doctrine.md (3)
27-29: Wording and Hyphenation Suggestions in Convention over Configuration Section
In the bullet beginning with “- React on Rails has taken the hard work out of figuring out the JavaScript tooling…”, consider refining the phrase “figure out how to splice it all together” for clarity. Additionally, review compound adjectives such as “client side” elsewhere in the document and hyphenate them (i.e. “client-side”) for consistency.🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: Write this as one word if you mean the noun “workout”.
Context: ...on - React on Rails has taken the hard work out of figuring out the JavaScript tooling ...(WORK_COMPOUNDS)
[grammar] ~27-~27: Using the adverb ‘altogether’ may be more appropriate in this context.
Context: ...u'd have to figure out how to splice it all together. This is where a lot of "JavaScript fat...(ALTOGETHER)
67-71: Refinement in Describing Value Integrated Systems
The text “document/database based with lots of business rules” may benefit from replacing “lots of” with “many” for conciseness. Also, if “client side” is used as a compound adjective, hyphenating it to “client-side” can improve clarity.🧰 Tools
🪛 LanguageTool
[style] ~67-~67: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...for Rails (document/database based with lots of business rules), the tight integration ...(A_LOT_OF)
77-79: Hyphenation for Compound Modifiers
In the bullet list under "Progress over Stability," consider hyphenating “client side” to “client-side” to ensure consistent and proper compound modifier usage.🧰 Tools
🪛 LanguageTool
[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p with: - Community suggestions. - New client side tooling, libraries, and techniques. - U...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/contributor-info/generator-testing.md (1)
3-3: Eliminate Redundancy in Option Description
The phrase “with various different options” is redundant. Consider revising it to either “with various options” or “with different options” for brevity and clarity.🧰 Tools
🪛 LanguageTool
[style] ~3-~3: This phrase is redundant. Consider writing “various” or “different”.
Context: ...ct_on_rails/install_generator.rb)) with various different options. We can then run tests with the...(VARIOUS_DIFFERENT)
docs/contributor-info/linters.md (3)
10-11: Revisit Wording for Directory Guidance
The instruction “Be sure to be in the right directory where you have Ruby files…” reads a bit repetitively. Consider rephrasing (for example, “Be sure you are in the correct directory containing your Ruby files…”) to avoid overusing “right.”
16-17: Punctuation Consistency for ESLint Instruction
The ESLint instruction shows a double colon (“eslint::”). A single colon should suffice for consistency with the RuboCop entry.-3. **eslint:**: Be sure to be in the right directory where you have JS files. +3. **eslint:** Be sure to be in the right directory where you have JS files.🧰 Tools
🪛 LanguageTool
[style] ~16-~16: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...` 3. eslint:: Be sure to be in the right directory where you have JS files. ```...(REP_RIGHT)
68-72: Reference Links Clarity
The “Useful Reference Links” section is now well formatted. As a minor note, review whether the link texts (e.g. “ESLint quick start”) might benefit from slightly more concise phrasing to avoid redundancy.🧰 Tools
🪛 LanguageTool
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ... Useful Reference Links - Configuring ESLint - [ESLint quick start](http://untilfalse.com/esli...(ENGLISH_WORD_REPEAT_RULE)
docs/javascript/server-rendering-tips.md (1)
15-15: Typo and Punctuation Improvement in Timeout Description
In the sentence “...babel-polyfill, did call setTimout.” the word “setTimout” appears to be misspelled—it should be “setTimeout.” Additionally, adding a comma after “babel-polyfill” can improve clarity.-... babel-polyfill, did call setTimout. +... babel-polyfill, did call setTimeout.docs/rails/turbolinks.md (4)
16-17: Outstanding TODO Reminder
Line 16 still contains a TODO note regarding walking through code changes in PR 1620. Please address this TODO before merging or consider opening an issue to track the required update.
37-39: List Numbering in “Why Not Turbolinks”
The “Why Not Turbolinks” section uses auto-numbering (all items start with “1.”). While Markdown supports this, consider manually numbering them for clarity if precise ordering is important.
42-47: Enhanced “More Information” Section with Detailed Insights
This section provides useful troubleshooting details on CSRF tokens, header handling, and potential pitfalls with Turbolinks5. As a minor improvement, consider inserting a comma before “however” in the sentence discussing CSRF token checks for better readability.-... I didn't look details however, may be it is app code related, not library code. +... I didn't look details, however, may be it is app code related, not library code.🧰 Tools
🪛 LanguageTool
[formatting] ~44-~44: Consider inserting a comma before ‘however’.
Context: ...ecs were not all passing. I didn't look details however, may be it is app code related, not libr...(HOWEVER_MISSING_COMMA)
[uncategorized] ~44-~44: Possible missing comma found.
Context: ... is app code related, not library code. Anyway it may need additional check because th...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Tur...(COMMA_COMPOUND_SENTENCE)
[grammar] ~44-~44: The pronoun ‘it’ requires a third-person verb or a past tense.
Context: ...e is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Turbolinks5...(HE_NEED)
96-102: Troubleshooting Asynchronous Loading
The instructions that follow regarding the re-initialization of components usingReactOnRails.reactOnRailsPageLoaded()are clear. As a minor note, adding a comma after “asynchronously” in the initial sentence may improve clarity.-... When loading your scripts asynchronously your components may not be registered correctly. +... When loading your scripts asynchronously, your components may not be registered correctly.🧰 Tools
🪛 LanguageTool
[uncategorized] ~96-~96: Possible missing comma found.
Context: ...ks/issues/28 When loading your scripts asynchronously your components may not be registered c...(AI_HYDRA_LEO_MISSING_COMMA)
docs/api/view-helpers-api.md (1)
1-4: Formatting Improvement in Header Section
The added spacing before and after the “## View Helpers API” header improves clarity and instantly establishes a better structure for the document.docs/guides/how-to-use-different-files-for-client-and-server-rendering.md (1)
17-23: Consistent Server Entry Example and Minor Language Suggestion
The Server Entry example is clear (lines 17–23). However, in the note “Note that the only difference is on the second line of each of these examples,” consider replacing “on” with “in” for natural phrasing (“... is in the second line …”).docs/guides/i18n.md (1)
97-100: Minor Grammar Note on Linting Instructions
The note advising running the rake task before linting is clear. However, consider rephrasing the sentence for conciseness (e.g., “If you lint before running tests—which build the translations—the linting may fail” rather than “if you try to lint before running tests…”).docs/javascript/capistrano-deployment.md (2)
15-17: Command Snippet Formatting Note
The code snippet now uses “```sh” and shows “$ bundle install”. Ensure this styling is consistent with project guidelines or consider removing the leading "$" if not showing expected output, as suggested by markdownlint-cli2.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
16-16: Dollar signs used before commands without showing output
null(MD014, commands-show-output)
25-25: Punctuation for Improved Readability
Consider adding a comma after “Webpack consumes a lot of memory” so the sentence reads:
“Webpack consumes a lot of memory, so if possible, try increasing the RAM of your server.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: A comma might be missing here.
Context: ...se of memory. Webpack consumes a lot of memory so if possible, try increasing the RAM ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/rails/rails-engine-integration.md (1)
35-38: Terminology Clarification in Issue Links
In the “Github Issues” section, the phrase “install generator” is used. Since “install” is typically a verb rather than a noun, consider rewording to “installation generator” or a similar phrase for clarity.🧰 Tools
🪛 LanguageTool
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...ture: target destination option for the install generator #459](https://github.com/shak...(A_INSTALL)
docs/additional-details/recommended-project-structure.md (3)
48-50: Discussion on Asset Pipeline Options
The added discussion providing a link to “Why does Rails 6 include both Webpacker and Sprockets?” is informative. As a minor nitpick, verify if the exclamatory “It depends!” fits the formal tone of the documentation.🧰 Tools
🪛 LanguageTool
[style] ~50-~50: Consider an alternative adjective to strengthen your wording.
Context: ...s asset pipeline? It depends! Here's a good discussion of this option: [Why does Ra...(GOOD_CONSTRUCTIVE)
55-57: Rephrase for Grammatical Clarity
The sentence “Your Rails layouts just doing the styling the standard Rails way” is grammatically incomplete. Consider revising it to:-Your Rails layouts just doing the styling the standard Rails way. +Your Rails layouts continue to handle styling in the standard Rails way.🧰 Tools
🪛 LanguageTool
[uncategorized] ~56-~56: Possible missing comma found.
Context: ...t get involved with styling. Your Rails layouts just doing the styling the standard Rai...(AI_HYDRA_LEO_MISSING_COMMA)
60-61: Refine Advantage Statement
In the “Advantages to the Simple Rails Way” section, the bullet “Much simpler! There's no changes really from your current processes.” could be refined for clarity. For example:-Much simpler! There's no changes really from your current processes. +Much simpler! There are no changes to your current processes.🧰 Tools
🪛 LanguageTool
[grammar] ~60-~60: Did you mean “There are no changes”?
Context: ... the Simple Rails Way 1. Much simpler! There's no changes really from your current processes. ##...(THERE_S_MANY)
docs/javascript/react-router.md (1)
40-40: Compound Adjective Consistency
In the comment on line 40, consider hyphenating “server side bundle” to “server-side bundle” for improved clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...dering** and should be only used in the server side bundle. From the [original example in ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
NEWS.md (4)
10-10: Verb Usage in Setup Instruction
In the entry for August 2, 2020, consider revising “a new way to setup the creation of your SSR bundle” to “a new way to set up the creation of your SSR bundle” so that the verb form is correctly applied.🧰 Tools
🪛 LanguageTool
[grammar] ~10-~10: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `r...(NOUN_VERB_CONFUSION)
20-20: Add Missing Determiner for Clarity
At 2017-04-25, the text “Only 'breaking' change is that you have to update both the node module and the Ruby gem.” could be improved. Consider updating it to “The only 'breaking' change is that you have to update both the node module and the Ruby gem.”🧰 Tools
🪛 LanguageTool
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ...rformance improvements! Please upgrade! Only "breaking" change is that you have to u...(AI_EN_LECTOR_MISSING_DETERMINER)
48-48: Clarify Preposition Usage
In the entry for 2016-02-28, the phrase “Please edit the page your project” should be revised to “Please edit the page for your project” for grammatical accuracy.🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Possible missing preposition found.
Context: ...age](PROJECTS.md). Please edit the page your project or [email us](mailto:contact@sh...(AI_HYDRA_LEO_MISSING_OF)
61-61: Hyphenation for Compound Modifiers
In the phrase “Skype plus Slack/GitHub based coaching”, consider hyphenating to “Skype-plus-Slack/GitHub-based coaching” to enhance readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~61-~61: This expression is usually spelled with a hyphen.
Context: ...hakacode.com) is doing Skype plus Slack/GitHub based coaching for "React on Rails". [Click h...(BASED_HYPHEN)
docs/misc/tips.md (2)
3-8: Formatting and Readability of Command Instructions
The tip at lines 3–8 uses an indented code block for theforeman start -f Procfile.devcommand. This renders correctly, but you might consider using a fenced code block (with triple backticks) for extra clarity and consistency with the other documentation files.
11-12: Consistent Capitalization and Phrasing
In the tip “Be sure you can first render your react component client only …”, please capitalize “React” (i.e. “React component”) and consider rewording “client only” to “client‑only” for clarity and consistency with common terminology.🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: “React” is a proper noun and needs to be capitalized.
Context: ...nt. - Be sure you can first render your react component client only before you tr...(A_GOOGLE)
CHANGELOG.md (4)
7-14: Heading and List Consistency
The “Want to Save Time Updating?” and “Contributors” sections look informative. However, several markdown lint warnings indicate that heading levels sometimes jump by more than one level (e.g. from h2 to h4). Please double‑check that the headers increment sequentially for improved readability.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
9-9: Bare URL used
null(MD034, no-bare-urls)
27-31: Bullet List Format for Change Entries
The “#### Added” section (lines 27–31) and other change categories are clearly presented. To further improve consistency, please verify that all bullet lists use the same marker style (dashes are preferred over asterisks) and that punctuation is uniform throughout the file.
34-41: Clear Presentation of Breaking Changes
The “#### Breaking Changes” section (lines 32–37) concisely lists key changes. Make sure that the style for listing configuration defaults (e.g. “force_load now defaults to true”) is consistently applied throughout the changelog.
50-69: Overall Changelog Structure
The remaining sections (from [14.2.0] through [14.1.0]) are well documented. However, please double‑check the overall heading structure to ensure that each new version entry is a consistent level (e.g. h3 or h4) so that the “Change Log” remains easy to navigate.docs/javascript/react-helmet.md (1)
39-44: Verifying JSX Prop Spread Syntax
Similarly, the change from- export default (props, railsContext) => (<App {{railsContext, ...props}} />); + export default (props, railsContext) => <App {{railsContext, ...props}} />;removes unnecessary parentheses. However, please verify that the syntax
<App {{railsContext, ...props}} />is intentional. In typical JSX the merged props are passed as<App {...{ railsContext, ...props }} />(with the spread operator before the object literal). If this change was made solely for formatting reasons, then it may be worth double‑checking the intended behavior.docs/additional-details/generator-details.md (2)
44-46: Concise Description of Folder Organization
The revised sentence “Each unique set of functionality is given its own folder inside ofapp/javascript/app/bundles” is clearer now. Consider removing the extra “of” (e.g. “given its own folder insideapp/javascript/app/bundles”) to make it even more concise.🧰 Tools
🪛 LanguageTool
[style] ~44-~44: This phrase is redundant. Consider using “inside”.
Context: ...f functionality is given its own folder inside ofapp/javascript/app/bundles. This enco...(OUTSIDE_OF)
[style] ~45-~45: This phrase is redundant. Consider using “Inside”.
Context: ...is encourages modularity of domains. Inside of the generated "HelloWorld" domain you w...(OUTSIDE_OF)
[uncategorized] ~46-~46: Possible missing comma found.
Context: .... Inside of the generated "HelloWorld" domain you will find the following folders: -...(AI_HYDRA_LEO_MISSING_COMMA)
48-51: Consistent Bullet List Punctuation
The bullet items (forstartup,containers, andcomponents) are clearly described. Please ensure that punctuation and wording are consistent across these items (for example, starting each description with a consistent verb such as “contains”).🧰 Tools
🪛 LanguageTool
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...find the following folders: -startup: contains the entry point files for webp...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...or decreased bundle size. -containers: contains "smart components" (components...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...child "dumb components"). -components: contains "dumb components", or componen...(UNLIKELY_OPENING_PUNCTUATION)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (3)
19-21: Minor Wording Suggestion for Server-Side Rendering Options
In the sentence “If you are using server-side rendering, then you have a couple options,” consider changing it to “you have a couple of options” for grammatical clarity.🧰 Tools
🪛 LanguageTool
[grammar] ~19-~19: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ... server-side rendering, then you have a couple options. The recommended technique is to have a...(PLENTY_OF_NOUNS)
80-84: Overlay Option Clarification
In the section where the snippet adds the ReactRefreshWebpackPlugin, consider adding a definitive article. For example, update the text to say “We added the overlay.sockPort option… This makes SockJS work properly…” This small change would address the language tool hints regarding missing determiners.
103-104: Clarifying Fallback Instructions
The sentence “If by some reason plugin doesn't work you could revert changes and left only devServer hmr/inline to true affecting only css files” can be made clearer. Perhaps rephrase it as:“If for some reason the plugin doesn’t work, you might revert the changes and keep only the devServer’s hmr/inline set to true—this will affect only CSS files.”
This will improve readability and clarity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~103-~103: A comma might be missing here.
Context: ...ding. If by some reason plugin doesn't work you could revert changes and left only ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~103-~103: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ... devServer hmr/inline to true affecting only css files. These plugins are working a...(ADVERB_REPETITION_PREMIUM)
docs/guides/upgrading-react-on-rails.md (2)
25-29: Upgrading to v12 – Recent Versions Heading
The new "Recent versions" heading and accompanying text clarify compatibility notes; however, consider adding an explicit note (if applicable) about which Rails versions are fully supported to help users on older releases.
38-41: Clarify i18n Helper Terminology
The section on the i18n default format works well overall. For accuracy and clarity, consider rewording “internalization helper” to “internationalization helper”. For example:- If you're using the internalization helper, then set `config.i18n_output_format = 'js'`. You can + If you're using the internationalization helper, then set `config.i18n_output_format = 'js'`. You candocs/release-notes/15.0.0.md (1)
27-29: Grammar Improvement on Force Load Description
In the “Component Hydration Changes” section, the sentence “Theforce_loadconfiguration make …” should use “makes” to ensure proper subject–verb agreement.- The `force_load` configuration make `react-on-rails` hydrate components immediately... + The `force_load` configuration makes `react-on-rails` hydrate components immediately...🧰 Tools
🪛 LanguageTool
[uncategorized] ~28-~28: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...l hydrate early without waiting for the full page load. This improves performance by elim...(EN_COMPOUND_ADJECTIVE_INTERNAL)
spec/dummy/client/README.md (4)
9-10: Heading Punctuation Consistency
The heading “Running linter:” includes a trailing colon. For stylistic consistency (per markdownlint MD026), consider removing the colon.- # Running linter: + # Running linter🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
9-9: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
21-24: Add Language Identifier for Code Block
For enhanced syntax highlighting and adherence to markdown best practices (MD040), add a language identifier (e.g.,sh) to the fenced code block.- ```sh + ```sh🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
21-21: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
21-21: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
25-29: Specify Language for Dependency Update Block
Similarly, consider adding a language specifier (such assh) to the code block under “Updating Node Dependencies” for consistency.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
25-25: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
25-25: Code block style
Expected: indented; Actual: fenced(MD046, code-block-style)
41-47: Code Block Language in “Adding Node Modules” Section
The instructions for adding node modules are clear. As a nitpick, adding a language specifier to the code block will improve readability and consistency.KUDOS.md (2)
13-18: Timeline Entry for June 9, 2017
The entry is well formatted and includes an appropriate image. As a good-to-have improvement, consider adding descriptive alt text for the image to boost accessibility.
37-42: Consistent Timeline Formatting
The timeline entries (e.g., for March 21, 2017) are clear and visually appealing. A minor nitpick: check that heading styles remain uniform across all entries.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (133)
.eslintrc(0 hunks).github/ISSUE_TEMPLATE/bug_report.md(0 hunks).github/ISSUE_TEMPLATE/feature_request.md(0 hunks).github/PULL_REQUEST_TEMPLATE.md(1 hunks).github/workflows/examples.yml(2 hunks).github/workflows/lint-js-and-ruby.yml(1 hunks).github/workflows/main.yml(2 hunks).github/workflows/package-js-tests.yml(1 hunks).github/workflows/rspec-package-specs.yml(1 hunks).prettierignore(1 hunks).prettierrc(1 hunks).scss-lint.yml(1 hunks)CHANGELOG.md(19 hunks)CONTRIBUTING.md(11 hunks)KUDOS.md(1 hunks)NEWS.md(1 hunks)PROJECTS.md(1 hunks)README.md(4 hunks)SUMMARY.md(1 hunks)docs/additional-details/generator-details.md(1 hunks)docs/additional-details/manual-installation-overview.md(1 hunks)docs/additional-details/migrating-from-react-rails.md(1 hunks)docs/additional-details/recommended-project-structure.md(2 hunks)docs/additional-details/tips-for-usage-with-sp6.md(1 hunks)docs/additional-details/updating-dependencies.md(2 hunks)docs/api/javascript-api.md(2 hunks)docs/api/redux-store-api.md(4 hunks)docs/api/view-helpers-api.md(8 hunks)docs/contributor-info/generator-testing.md(1 hunks)docs/contributor-info/linters.md(2 hunks)docs/contributor-info/pull-requests.md(2 hunks)docs/contributor-info/releasing.md(1 hunks)docs/deployment/elastic-beanstalk.md(1 hunks)docs/deployment/heroku-deployment.md(1 hunks)docs/getting-started.md(7 hunks)docs/guides/client-vs-server-rendering.md(2 hunks)docs/guides/configuration.md(4 hunks)docs/guides/file-system-based-automated-bundle-generation.md(5 hunks)docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md(1 hunks)docs/guides/how-react-on-rails-works.md(2 hunks)docs/guides/how-to-use-different-files-for-client-and-server-rendering.md(3 hunks)docs/guides/i18n.md(1 hunks)docs/guides/installation-into-an-existing-rails-app.md(2 hunks)docs/guides/minitest-configuration.md(1 hunks)docs/guides/rails-webpacker-react-integration-options.md(7 hunks)docs/guides/react-on-rails-overview.md(1 hunks)docs/guides/react-server-rendering.md(2 hunks)docs/guides/render-functions-and-railscontext.md(6 hunks)docs/guides/rspec-configuration.md(4 hunks)docs/guides/streaming-server-rendering.md(4 hunks)docs/guides/tutorial.md(12 hunks)docs/guides/upgrading-react-on-rails.md(13 hunks)docs/guides/webpack-configuration.md(2 hunks)docs/home.md(2 hunks)docs/javascript/angular-js-integration-migration.md(2 hunks)docs/javascript/capistrano-deployment.md(1 hunks)docs/javascript/code-splitting.md(5 hunks)docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md(1 hunks)docs/javascript/credits.md(0 hunks)docs/javascript/foreman-issues.md(1 hunks)docs/javascript/images.md(0 hunks)docs/javascript/node-dependencies-and-npm.md(1 hunks)docs/javascript/react-and-redux.md(1 hunks)docs/javascript/react-helmet.md(6 hunks)docs/javascript/react-router.md(2 hunks)docs/javascript/server-rendering-tips.md(2 hunks)docs/javascript/troubleshooting-when-using-shakapacker.md(1 hunks)docs/javascript/troubleshooting-when-using-webpacker.md(1 hunks)docs/javascript/webpack-v1-notes.md(1 hunks)docs/javascript/webpack.md(1 hunks)docs/misc/articles.md(1 hunks)docs/misc/doctrine.md(2 hunks)docs/misc/style.md(1 hunks)docs/misc/tips.md(1 hunks)docs/outdated/deferred-rendering.md(2 hunks)docs/outdated/rails-assets-relative-paths.md(8 hunks)docs/outdated/rails-assets.md(2 hunks)docs/outdated/rails3.md(1 hunks)docs/rails/rails-engine-integration.md(2 hunks)docs/rails/rails_view_rendering_from_inline_javascript.md(2 hunks)docs/rails/turbolinks.md(3 hunks)docs/release-notes/15.0.0.md(3 hunks)docs/testimonials/resortpass.md(1 hunks)docs/testimonials/testimonials.md(1 hunks)knip.ts(1 hunks)lib/generators/react_on_rails/templates/.eslintrc(1 hunks)lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.module.css(1 hunks)lib/generators/react_on_rails/templates/base/base/config/shakapacker.yml(1 hunks)node_package/src/Authenticity.ts(1 hunks)node_package/src/CallbackRegistry.ts(4 hunks)node_package/src/ClientSideRenderer.ts(10 hunks)node_package/src/ComponentRegistry.ts(2 hunks)node_package/src/RSCClientRoot.ts(5 hunks)node_package/src/ReactOnRails.client.ts(7 hunks)node_package/src/ReactOnRails.full.ts(2 hunks)node_package/src/ReactOnRailsRSC.ts(2 hunks)node_package/src/StoreRegistry.ts(2 hunks)node_package/src/buildConsoleReplay.ts(2 hunks)node_package/src/clientStartup.ts(1 hunks)node_package/src/context.ts(1 hunks)node_package/src/createReactOutput.ts(3 hunks)node_package/src/handleError.ts(2 hunks)node_package/src/isRenderFunction.ts(1 hunks)node_package/src/isServerRenderResult.ts(1 hunks)node_package/src/pageLifecycle.ts(1 hunks)node_package/src/reactApis.ts(1 hunks)node_package/src/reactHydrateOrRender.ts(1 hunks)node_package/src/registerServerComponent/client.ts(2 hunks)node_package/src/registerServerComponent/server.ts(1 hunks)node_package/src/serverRenderReactComponent.ts(8 hunks)node_package/src/serverRenderUtils.ts(2 hunks)node_package/src/streamServerRenderedReactComponent.ts(8 hunks)node_package/src/transformRSCStreamAndReplayConsoleLogs.ts(3 hunks)node_package/src/turbolinksUtils.ts(2 hunks)node_package/src/types/index.ts(6 hunks)node_package/src/utils.ts(1 hunks)package-scripts.yml(2 hunks)package.json(1 hunks)rakelib/examples_config.yml(1 hunks)spec/dummy/.prettierignore(0 hunks)spec/dummy/.prettierrc(0 hunks)spec/dummy/README.md(2 hunks)spec/dummy/app/assets/stylesheets/application_non_webpack.scss(1 hunks)spec/dummy/client/.jscsrc(0 hunks)spec/dummy/client/README.md(3 hunks)spec/dummy/client/app/components/CssModulesImagesFontsExample.module.scss(2 hunks)spec/dummy/client/app/components/ImageExample/ImageExample.module.scss(1 hunks)spec/dummy/client/app/startup/RouterApp.server.jsx(1 hunks)spec/dummy/config/locales/en.yml(1 hunks)spec/dummy/config/shakapacker.yml(1 hunks)spec/dummy/config/storage.yml(0 hunks)spec/react_on_rails/fixtures/i18n/locales/de.yml(1 hunks)spec/react_on_rails/fixtures/i18n/locales/en.yml(1 hunks)
💤 Files with no reviewable changes (9)
- docs/javascript/credits.md
- .github/ISSUE_TEMPLATE/bug_report.md
- .github/ISSUE_TEMPLATE/feature_request.md
- docs/javascript/images.md
- spec/dummy/client/.jscsrc
- spec/dummy/.prettierrc
- spec/dummy/config/storage.yml
- .eslintrc
- spec/dummy/.prettierignore
🚧 Files skipped from review as they are similar to previous changes (80)
- docs/guides/react-on-rails-overview.md
- docs/additional-details/migrating-from-react-rails.md
- docs/testimonials/testimonials.md
- spec/dummy/app/assets/stylesheets/application_non_webpack.scss
- spec/react_on_rails/fixtures/i18n/locales/de.yml
- docs/additional-details/tips-for-usage-with-sp6.md
- docs/guides/rspec-configuration.md
- node_package/src/pageLifecycle.ts
- docs/outdated/deferred-rendering.md
- node_package/src/utils.ts
- lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.module.css
- .github/PULL_REQUEST_TEMPLATE.md
- node_package/src/clientStartup.ts
- spec/dummy/config/shakapacker.yml
- docs/javascript/node-dependencies-and-npm.md
- docs/guides/minitest-configuration.md
- spec/react_on_rails/fixtures/i18n/locales/en.yml
- node_package/src/turbolinksUtils.ts
- docs/guides/installation-into-an-existing-rails-app.md
- node_package/src/ReactOnRails.full.ts
- node_package/src/registerServerComponent/server.ts
- node_package/src/ComponentRegistry.ts
- node_package/src/CallbackRegistry.ts
- docs/javascript/react-and-redux.md
- node_package/src/ReactOnRailsRSC.ts
- docs/javascript/troubleshooting-when-using-shakapacker.md
- docs/additional-details/updating-dependencies.md
- docs/contributor-info/releasing.md
- node_package/src/registerServerComponent/client.ts
- docs/guides/configuration.md
- SUMMARY.md
- .scss-lint.yml
- node_package/src/createReactOutput.ts
- node_package/src/StoreRegistry.ts
- .github/workflows/lint-js-and-ruby.yml
- docs/javascript/troubleshooting-when-using-webpacker.md
- rakelib/examples_config.yml
- node_package/src/handleError.ts
- .github/workflows/rspec-package-specs.yml
- docs/guides/webpack-configuration.md
- lib/generators/react_on_rails/templates/base/base/config/shakapacker.yml
- .prettierrc
- docs/guides/rails-webpacker-react-integration-options.md
- node_package/src/reactApis.ts
- .github/workflows/examples.yml
- node_package/src/serverRenderReactComponent.ts
- spec/dummy/client/app/components/CssModulesImagesFontsExample.module.scss
- docs/javascript/code-splitting.md
- node_package/src/RSCClientRoot.ts
- docs/guides/client-vs-server-rendering.md
- node_package/src/streamServerRenderedReactComponent.ts
- docs/api/redux-store-api.md
- docs/javascript/webpack.md
- node_package/src/context.ts
- node_package/src/Authenticity.ts
- .github/workflows/main.yml
- .github/workflows/package-js-tests.yml
- docs/guides/react-server-rendering.md
- docs/rails/rails_view_rendering_from_inline_javascript.md
- docs/guides/render-functions-and-railscontext.md
- node_package/src/ReactOnRails.client.ts
- spec/dummy/client/app/startup/RouterApp.server.jsx
- node_package/src/transformRSCStreamAndReplayConsoleLogs.ts
- docs/deployment/heroku-deployment.md
- spec/dummy/config/locales/en.yml
- knip.ts
- package-scripts.yml
- lib/generators/react_on_rails/templates/.eslintrc
- package.json
- docs/misc/articles.md
- .prettierignore
- docs/guides/streaming-server-rendering.md
- node_package/src/buildConsoleReplay.ts
- docs/api/javascript-api.md
- spec/dummy/client/app/components/ImageExample/ImageExample.module.scss
- node_package/src/isServerRenderResult.ts
- node_package/src/ClientSideRenderer.ts
- node_package/src/types/index.ts
- node_package/src/isRenderFunction.ts
- node_package/src/serverRenderUtils.ts
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CHANGELOG.md
9-9: Bare URL used
null
(MD034, no-bare-urls)
245-245: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
427-427: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
428-428: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
452-452: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
617-617: Bare URL used
null
(MD034, no-bare-urls)
621-621: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
745-745: Spaces inside link text
null
(MD039, no-space-in-links)
750-750: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
753-753: Spaces inside link text
null
(MD039, no-space-in-links)
761-761: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
767-767: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
780-780: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
796-796: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
798-798: Bare URL used
null
(MD034, no-bare-urls)
803-803: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
809-809: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
834-834: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
838-838: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
844-844: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
854-854: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
860-860: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
866-866: Spaces inside link text
null
(MD039, no-space-in-links)
870-870: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
876-876: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
887-887: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
893-893: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
899-899: Bare URL used
null
(MD034, no-bare-urls)
908-908: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
914-914: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
926-926: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
936-936: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
961-961: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
967-967: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
975-975: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
985-985: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
995-995: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
1009-1009: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
1015-1015: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1021-1021: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1028-1028: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1036-1036: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1042-1042: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1060-1060: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1066-1066: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1072-1072: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1074-1074: Spaces inside link text
null
(MD039, no-space-in-links)
1078-1078: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1087-1087: Spaces inside link text
null
(MD039, no-space-in-links)
1093-1093: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1099-1099: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1105-1105: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1111-1111: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1117-1117: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1123-1123: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1183-1183: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1197-1197: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1207-1207: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1239-1239: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1245-1245: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1251-1251: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1257-1257: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1290-1290: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1296-1296: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1302-1302: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1309-1309: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1317-1317: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1323-1323: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1329-1329: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1373-1373: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1381-1381: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1387-1387: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1399-1399: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1433-1433: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
1452-1452: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
1461-1461: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
1467-1467: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
1473-1473: Bare URL used
null
(MD034, no-bare-urls)
1476-1476: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1494-1494: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1504-1504: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
1524-1524: Heading levels should only increment by one level at a time
Expected: h3; Actual: h5
(MD001, heading-increment)
CONTRIBUTING.md
7-7: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
KUDOS.md
70-70: Bare URL used
null
(MD034, no-bare-urls)
106-106: Bare URL used
null
(MD034, no-bare-urls)
PROJECTS.md
52-52: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
docs/additional-details/recommended-project-structure.md
32-32: Trailing punctuation in heading
Punctuation: '.'
(MD026, no-trailing-punctuation)
docs/contributor-info/pull-requests.md
22-22: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md
28-28: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
docs/guides/how-react-on-rails-works.md
5-5: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
5-5: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
docs/guides/tutorial.md
7-7: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
25-25: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
docs/javascript/capistrano-deployment.md
16-16: Dollar signs used before commands without showing output
null
(MD014, commands-show-output)
docs/javascript/converting-from-custom-webpack-config-to-rails-webpacker-config.md
10-10: Bare URL used
null
(MD034, no-bare-urls)
docs/javascript/react-helmet.md
27-27: Bare URL used
null
(MD034, no-bare-urls)
docs/outdated/rails-assets-relative-paths.md
1-1: Emphasis used instead of a heading
null
(MD036, no-emphasis-as-heading)
docs/rails/turbolinks.md
94-94: Bare URL used
null
(MD034, no-bare-urls)
spec/dummy/client/README.md
9-9: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
21-21: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
21-21: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
25-25: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
25-25: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
🪛 LanguageTool
CONTRIBUTING.md
[uncategorized] ~22-~22: A comma may be missing after the conjunctive/linking adverb ‘Otherwise’.
Context: ...E/editor to ignore certain directories. Otherwise your IDE might slow to a crawl! - /cov...
(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
[style] ~81-~81: Consider shortening or rephrasing this to strengthen your wording.
Context: ...eact-on-rails ``` The workflow is: 1. Make changes to the node package. 2. We need yalc to pu...
(MAKE_CHANGES)
[style] ~185-~185: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...figs, then you need to restart foreman. If you change the JS code for react-on-rai...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~205-~205: Possible missing comma found.
Context: .... ### Install Generator In your Rails app add this gem with a path to your fork. ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~237-~237: The word ‘lint’ is a noun or an adjective. A verb or adverb is missing or misspelled here, or maybe a comma is missing.
Context: ...changes via the lint container. You can lint locally by running `npm run lint && npm...
(PRP_MD_NN)
[grammar] ~242-~242: The word ‘install’ is not a noun.
Context: ...he initial build is slow, but after the install, startup is very quick. ### Linting Co...
(A_INSTALL)
[style] ~242-~242: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...slow, but after the install, startup is very quick. ### Linting Commands Run rake lint...
(EN_WEAK_ADJECTIVE)
KUDOS.md
[style] ~49-~49: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...ators are great and the community is so awesome and welcoming. In fact, I love it so mu...
(AWESOME)
[grammar] ~49-~49: “React” is a proper noun and needs to be capitalized.
Context: ...Rails](https://goo.gl/uzu36X) using the react_on_rails gem!" ![The Complete React on ...
(A_GOOGLE)
[style] ~102-~102: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1997 characters long)
Context: ...ls gems to manage front end dependencies! React on Rails provides webpack integra...
(EN_EXCESSIVE_EXCLAMATION)
NEWS.md
[grammar] ~10-~10: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `r...
(NOUN_VERB_CONFUSION)
[uncategorized] ~12-~12: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...v12**. 1. React Hooks Support for top level components 2. Typescript bindings...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~20-~20: A determiner appears to be missing. Consider inserting it.
Context: ...rformance improvements! Please upgrade! Only "breaking" change is that you have to u...
(AI_EN_LECTOR_MISSING_DETERMINER)
[inconsistency] ~29-~29: Did you mean to refer to the current year? November 10, 2025 is not a Thursday, but a Monday.
Context: ...) - 2016-11-03: Spoke at [LA Ruby, 7pm, Thursday, November 10 in Venice, CA: "React on Rails: Why, Wh...
(EN_DATE_WEEKDAY_CURRENTYEAR)
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...with a critical fix if you are fragment caching the server generated React. - 2016-05-2...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~48-~48: Possible missing preposition found.
Context: ...age](PROJECTS.md). Please edit the page your project or [email us](mailto:contact@sh...
(AI_HYDRA_LEO_MISSING_OF)
[style] ~49-~49: Consider an alternative verb to strengthen your wording.
Context: ...md) for details, and let us know if you see any issues! [Migration steps from 1.x](...
(IF_YOU_HAVE_THIS_PROBLEM)
[uncategorized] ~60-~60: Possible missing comma found.
Context: ...modules and hot reloading via the Rails server as is demonstrated in the [shakacode/re...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~60-~60: “React” is a proper noun and needs to be capitalized.
Context: ...._ If you did generate a fresh app from react_on_rails and want to move to CSS Module...
(A_GOOGLE)
[style] ~60-~60: Using many exclamation marks might seem excessive (in this case: 20 exclamation marks for a text that’s 8677 characters long)
Context: ...information. Ping us if you want to help! - ShakaCode...
(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~61-~61: This expression is usually spelled with a hyphen.
Context: ...hakacode.com) is doing Skype plus Slack/GitHub based coaching for "React on Rails". [Click h...
(BASED_HYPHEN)
PROJECTS.md
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...You can confirm a project uses React on Rails as the source will contain **`js-react-...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...eals](https://www.redflagdeals.com/)**, Canadian shopping site. - **[YourMechanic](https...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~22-~22: You might be missing the article “a” here.
Context: ...](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. - **[HVMN...
(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~29-~29: This word is normally spelled as one.
Context: ...has gone live with React on Rails, with multi-lingual JavaScript support! ![2016-05-03_19-1...
(EN_COMPOUNDS_MULTI_LINGUAL)
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...lational Marketing for Real Estate. ## Open Source Projects Live - [github.com/empirical-...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~61-~61: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ps://github.com/sharetribe/sharetribe): Open source marketplace platform.
(EN_COMPOUND_ADJECTIVE_INTERNAL)
README.md
[style] ~87-~87: Style-wise, it’s not ideal to insert an adverb (‘conditionally’) in the middle of an infinitive construction (‘to render’). Try moving the adverb to avoid split infinitives.
Context: ...lient-and-server-rendering/1352) - [How to conditionally render server side based on the device type](https://forum...
(SPLIT_INFINITIVE)
docs/additional-details/generator-details.md
[style] ~44-~44: This phrase is redundant. Consider using “inside”.
Context: ...f functionality is given its own folder inside of app/javascript/app/bundles. This enco...
(OUTSIDE_OF)
[style] ~45-~45: This phrase is redundant. Consider using “Inside”.
Context: ...is encourages modularity of domains. Inside of the generated "HelloWorld" domain you w...
(OUTSIDE_OF)
[uncategorized] ~46-~46: Possible missing comma found.
Context: .... Inside of the generated "HelloWorld" domain you will find the following folders: -...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...find the following folders: - startup: contains the entry point files for webp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...or decreased bundle size. - containers: contains "smart components" (components...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...child "dumb components"). - components: contains "dumb components", or componen...
(UNLIKELY_OPENING_PUNCTUATION)
docs/additional-details/manual-installation-overview.md
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...eet_pack_tagandjavascript_pack_tag` helpers which is used to load the bundled asset...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~22-~22: The verb “is” doesn’t seem to fit in this context, “are” is probably more formally correct.
Context: ...and javascript_pack_tag helpers which is used to load the bundled assets to your...
(AI_HYDRA_LEO_CPT_IS_ARE)
docs/additional-details/recommended-project-structure.md
[style] ~50-~50: Consider an alternative adjective to strengthen your wording.
Context: ...s asset pipeline? It depends! Here's a good discussion of this option: [Why does Ra...
(GOOD_CONSTRUCTIVE)
[uncategorized] ~56-~56: Possible missing comma found.
Context: ...t get involved with styling. Your Rails layouts just doing the styling the standard Rai...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~60-~60: Did you mean “There are no changes”?
Context: ... the Simple Rails Way 1. Much simpler! There's no changes really from your current processes. ##...
(THERE_S_MANY)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...ctory structure 1. /client/app/assets: Assets for CSS for client app. 1. `/cli...
(UNLIKELY_OPENING_PUNCTUATION)
docs/api/view-helpers-api.md
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... you want to see the server side or the client side rails_context. Typically, for computing...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/contributor-info/generator-testing.md
[style] ~3-~3: This phrase is redundant. Consider writing “various” or “different”.
Context: ...ct_on_rails/install_generator.rb)) with various different options. We can then run tests with the...
(VARIOUS_DIFFERENT)
docs/contributor-info/linters.md
[style] ~16-~16: You have already used ‘right’ in nearby sentences. Consider using an alternative word to let your writing stand out and sound more polished.
Context: ...` 3. eslint:: Be sure to be in the right directory where you have JS files. ```...
(REP_RIGHT)
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ... Useful Reference Links - Configuring ESLint - [ESLint quick start](http://untilfalse.com/esli...
(ENGLISH_WORD_REPEAT_RULE)
docs/contributor-info/pull-requests.md
[uncategorized] ~5-~5: Loose punctuation mark.
Context: ...# Checklist before Committing 1. rake: runs all linters and specs (you need Do...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Possible missing article found.
Context: ...d entry? For non-doc fixes: - Provide changelog entry in the [unreleased section of the...
(AI_HYDRA_LEO_MISSING_A)
docs/deployment/elastic-beanstalk.md
[grammar] ~47-~47: “React” is a proper noun and needs to be capitalized.
Context: ...ic beanstalk successfully. However, the react app javascript files are under `public/...
(A_GOOGLE)
docs/getting-started.md
[uncategorized] ~144-~144: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...iguration file that can use a different server side entry file, like 'serverRegistration.js...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/guides/file-system-based-automated-bundle-generation.md
[typographical] ~180-~180: After the expression ‘for example’ a comma is usually used.
Context: ...ry` nor directly add their bundles. For example you can have a Rails view using three c...
(COMMA_FOR_EXAMPLE)
[style] ~209-~209: Consider a shorter alternative to avoid wordiness.
Context: ...ge both in server and client rendering. In order to have separate definitions for client an...
(IN_ORDER_TO_PREMIUM)
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md
[uncategorized] ~11-~11: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...efresh). For use with webpack, see **Client Side rendering and HMR using react-refresh-w...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~17-~17: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...cker-dev-server` during development. # Server Side Rendering with the Default shakacode/sh...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~19-~19: Using ‘couple’ without ‘of’ is considered to be informal.
Context: ... server-side rendering, then you have a couple options. The recommended technique is to have a...
(PLENTY_OF_NOUNS)
[uncategorized] ~88-~88: You might be missing the article “the” here.
Context: ... }), ); } ``` We added overlay.sockPort option in `ReactRefres...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~88-~88: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...fig/shakapacker.yml`. This makes SockJS works properly and fixes this error in browse...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~88-~88: You might be missing the article “the” here.
Context: ... works properly and fixes this error in browser console: `GET http://localhost:[port]/s...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~103-~103: A comma might be missing here.
Context: ...ding. If by some reason plugin doesn't work you could revert changes and left only ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~103-~103: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ... devServer hmr/inline to true affecting only css files. These plugins are working a...
(ADVERB_REPETITION_PREMIUM)
docs/guides/how-to-use-different-files-for-client-and-server-rendering.md
[uncategorized] ~25-~25: The preposition “in” seems more likely in this position than the preposition “on”.
Context: ...; ``` Note that the only difference is on the second line of each of these exampl...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_ON_IN)
docs/guides/i18n.md
[grammar] ~30-~30: Normally, after “try to” a verb is expected.
Context: ... as well. > [!NOTE] > If you try to lint before running tests, and you depend on...
(WANT_TO_NN)
docs/guides/upgrading-react-on-rails.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...nfiguration to a better setup ready for Server Side Rendering. ## Upgrading to v13 ### Br...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~62-~62: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ion will be treated as a render function and it can return an Object rather than a R...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~133-~133: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...(https://github.com/rails/webpacker) to setup your Webpack configuration. ```yml def...
(NOUN_VERB_CONFUSION)
[uncategorized] ~165-~165: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ndles to bypass the Rails asset pipeline and it's extra minification, enabling you t...
(COMMA_COMPOUND_SENTENCE)
[uncategorized] ~171-~171: Loose punctuation mark.
Context: ... your client directory - .gitignore: add /public/webpack/* - Gemfile: bu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ... config/initializers/react_on_rails.rb: - Delete `config.generated_assets_dir...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~178-~178: The verb ‘Replace’ is plural. Did you mean: “replaces”? Did you use a verb instead of a noun?
Context: ...onfig now supplies this information - Replace `config.npm_build_(test|production)_com...
(PLURAL_VERB_AFTER_THIS)
[uncategorized] ~180-~180: Loose punctuation mark.
Context: ...urrently broken. - client/package.json: bump react_on_rails (I recommend bump...
(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~225-~225: This phrase is duplicated. You should probably use “Run Run” only once.
Context: ...rade RoR in the client/package.json - Run bundle - Run rails webpacker:install - Run rails webpacker:install:react - Run rails g react_on_rails:install - Move...
(PHRASE_REPETITION)
[style] ~242-~242: This phrase is redundant. Consider using “inside”.
Context: ...toconfig/initializers/react_on_rails.rbto keep your node_modules inside of/client 2. Renamed - config.npm_b...
(OUTSIDE_OF)
[formatting] ~269-~269: These punctuation marks differ from each other. Use only one if you are ending a sentence.
Context: ...name,** unless the bundle is server side.: ``` const webpackConfigLoader ...
(DOUBLE_PUNCTUATION_PREMIUM)
[duplication] ~300-~300: Possible typo: you repeated a word.
Context: ...packer.yml - If you are not using the webpacker webpacker setup, be sure to put in `compile: fals...
(ENGLISH_WORD_REPEAT_RULE)
docs/home.md
[grammar] ~22-~22: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...on_rails_demo_ssr_hmr) for a new way to setup the creation of your SSR bundle with `s...
(NOUN_VERB_CONFUSION)
docs/javascript/angular-js-integration-migration.md
[grammar] ~7-~7: The word “setup” is a noun. The verb is spelled with a space.
Context: ...ave not already done this, then you can setup the ReactOnRails default JS code dire...
(NOUN_VERB_CONFUSION)
[style] ~7-~7: Did you mean ‘different from’? ‘Different than’ is often considered colloquial style.
Context: ...inclusion this way will be no different than using the Rails asset pipeline. However...
(DIFFERENT_THAN)
docs/javascript/capistrano-deployment.md
[uncategorized] ~25-~25: A comma might be missing here.
Context: ...se of memory. Webpack consumes a lot of memory so if possible, try increasing the RAM ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
docs/javascript/foreman-issues.md
[uncategorized] ~11-~11: You might be missing the article “the” here.
Context: ...ailing to finish upload file to S3 when server was started by `foreman -f Procfile.dev...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/javascript/react-helmet.md
[style] ~10-~10: Consider a shorter alternative to avoid wordiness.
Context: ...## Example Here is what you need to do in order to configure your Rails application to wor...
(IN_ORDER_TO_PREMIUM)
[uncategorized] ~92-~92: You might be missing the article “an” here.
Context: ...gument it will return a hash instead of HTML string. Note, there is no need to speci...
(AI_EN_LECTOR_MISSING_DETERMINER_AN)
[grammar] ~93-~93: Did you mean the proper noun or did you want to use it as a verb?
Context: ...rerender" as it would not make sense to use react_component_hash without server rendering...
(HAVE_TWITTER)
docs/javascript/react-router.md
[uncategorized] ~40-~40: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...dering** and should be only used in the server side bundle. From the [original example in ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/javascript/server-rendering-tips.md
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Your code can't reference document. Server side JS execution does not have access to `d...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~30-~30: Possible missing comma found.
Context: ...d call setTimout. Here's an example of this which shows the line numbers that end u...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/javascript/webpack-v1-notes.md
[style] ~7-~7: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1166 characters long)
Context: ...ment halt if Webpack cannot complete! For more details, see the documentation...
(EN_EXCESSIVE_EXCLAMATION)
[uncategorized] ~7-~7: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... Webpack returning a non-zero error code and you want to see all the errors, rather ...
(COMMA_COMPOUND_SENTENCE)
docs/misc/doctrine.md
[uncategorized] ~27-~27: Write this as one word if you mean the noun “workout”.
Context: ...on - React on Rails has taken the hard work out of figuring out the JavaScript tooling ...
(WORK_COMPOUNDS)
[grammar] ~27-~27: Using the adverb ‘altogether’ may be more appropriate in this context.
Context: ...u'd have to figure out how to splice it all together. This is where a lot of "JavaScript fat...
(ALTOGETHER)
[uncategorized] ~63-~63: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: .... ES6 is beautiful. React is beautiful. Client side code written with React plus Redux, ful...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~67-~67: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...for Rails (document/database based with lots of business rules), the tight integration ...
(A_LOT_OF)
[uncategorized] ~78-~78: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...p with: - Community suggestions. - New client side tooling, libraries, and techniques. - U...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/misc/style.md
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...n. - Anything additional goes next. ## Client Side JavaScript and React - See the [Shakac...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/misc/tips.md
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ht now is prerender: false. NOTE: Server side rendering does not work for some compon...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~11-~11: “React” is a proper noun and needs to be capitalized.
Context: ...nt. - Be sure you can first render your react component client only before you tr...
(A_GOOGLE)
docs/outdated/rails-assets-relative-paths.md
[grammar] ~51-~51: After the number ‘two’, use a plural noun. Did you mean “examples”?
Context: ...name].[ext]', }, ``` both of these two example above do the exact same thing, just usi...
(CD_NNU)
[style] ~51-~51: ‘exact same’ might be wordy. Consider a shorter alternative.
Context: ... both of these two example above do the exact same thing, just using different syntaxes. F...
(EN_WORDINESS_PREMIUM_EXACT_SAME)
[uncategorized] ~51-~51: Possible missing comma found.
Context: ...ifferent syntaxes. For the rest of this doc we will be using the JSON object style....
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~53-~53: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...k.github.io/docs/using-loaders.html). _For the sake of this doc, we're also going ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[typographical] ~61-~61: Consider adding a comma here.
Context: ...r file's resulting name after bundling. For now we're just going to use: ```javascript...
(FOR_NOW_COMMA)
[style] ~67-~67: In American English, abbreviations like “etc.” require a period.
Context: ...nsion of the original file (.png, .jpg, etc). Next we'll set the outputPath for ou...
(ETC_PERIOD)
docs/outdated/rails-assets.md
[uncategorized] ~8-~8: Did you mean: “By default,”?
Context: ...e other term for this is a "digest". > By default the filename of the resulting file is t...
(BY_DEFAULT_COMMA)
docs/outdated/rails3.md
[style] ~3-~3: Consider using a different verb to strengthen your wording.
Context: # Rails 3 - Please let us know if you find any issues with Rails 3. - Rails 3 is c...
(FIND_ENCOUNTER)
[style] ~5-~5: Consider using a different verb to strengthen your wording.
Context: ...not testing it for new releases. If you find an issue, you will have to submit a PR ...
(FIND_ENCOUNTER)
docs/rails/rails-engine-integration.md
[grammar] ~36-~36: The word ‘install’ is not a noun.
Context: ...ture: target destination option for the install generator #459](https://github.com/shak...
(A_INSTALL)
docs/rails/turbolinks.md
[typographical] ~11-~11: It seems that a comma is missing.
Context: ... obsolete. # Using Turbo To configure Turbo the following option can be set: `React...
(IN_ORDER_TO_VB_COMMA)
[formatting] ~44-~44: Consider inserting a comma before ‘however’.
Context: ...ecs were not all passing. I didn't look details however, may be it is app code related, not libr...
(HOWEVER_MISSING_COMMA)
[uncategorized] ~44-~44: Possible missing comma found.
Context: ... is app code related, not library code. Anyway it may need additional check because th...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~44-~44: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...use there is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Tur...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~44-~44: The pronoun ‘it’ requires a third-person verb or a past tense.
Context: ...e is CSRF helper in ReactOnRails and it need to work with Turbolinks5. - Turbolinks5...
(HE_NEED)
[uncategorized] ~96-~96: Possible missing comma found.
Context: ...ks/issues/28 When loading your scripts asynchronously your components may not be registered c...
(AI_HYDRA_LEO_MISSING_COMMA)
docs/release-notes/15.0.0.md
[uncategorized] ~28-~28: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...l hydrate early without waiting for the full page load. This improves performance by elim...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~31-~31: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...ded. - The force_load configuration make react-on-rails hydrate components imm...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...hes the client, without waiting for the full page load. - If you want to keep the previ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~33-~33: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...zers/react_on_rails.rbfile. - If we want to keep the original behavior offorce_lo...
(REP_WANT_TO_VB)
[uncategorized] ~34-~34: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...ce_loadconfiguration. - Redux store supportforce_loadoption now and it usesco...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~34-~34: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ux store support force_load option now and it uses config.force_load value as th...
(COMMA_COMPOUND_SENTENCE)
docs/testimonials/resortpass.md
[style] ~3-~3: Consider an alternative adjective to strengthen your wording.
Context: ...ted code that both works and reflects a deep understanding of the technologies and p...
(DEEP_PROFOUND)
[grammar] ~3-~3: “React” is a proper noun and needs to be capitalized.
Context: ...s and standards for our transition to a react on rails application. Just three months...
(A_GOOGLE)
spec/dummy/README.md
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e spec/dummy/client/node_modules to the top level - Be sure to install yarn dependencies ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 Biome (1.9.4)
node_package/src/reactHydrateOrRender.ts
[error] 38-38: Do not depend on the value returned by the function ReactDOM.render().
The returned value is legacy and future versions of React might return that value asynchronously.
Check the React documentation for more information.
(lint/correctness/noRenderReturnValue)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: dummy-app-integration-tests (newest)
- GitHub Check: dummy-app-integration-tests (oldest)
- GitHub Check: examples (newest)
🔇 Additional comments (97)
docs/outdated/rails-assets.md (1)
3-3: Update Documentation Note on Shakapacker / Webpacker Transition
The insertion of the italicized note is helpful for alerting readers that the doc requires updating. Ensure that this style is applied consistently across related documentation.docs/javascript/webpack-v1-notes.md (1)
10-10: Enhanced Section Separation
The inserted blank line before the "Entry Points" section improves readability by clearly delineating the sections.docs/home.md (5)
4-4: Improved Readability with Blank Line Addition
Adding a blank line after the "## Details" header enhances the document’s clarity and visual separation.
14-14: Clear Section Transition in ‘Changes and Upgrades’
The added blank line after the "## Changes and Upgrades" header contributes positively to the structure without impacting content.
19-19: Bullet List Readability Enhancement
The blank line before the "Example Apps" section helps distinguish it from the previous content; this is a welcome formatting improvement.
21-21: Indentation Clarity in Bullet Description
The adjusted indentation for the continuation line (“that supports SSR.”) clarifies that it belongs to the preceding bullet point.
26-26: Effective Section Separation for 'Other Resources'
The inserted blank line before the "Other Resources" header further enhances document organization.docs/guides/how-react-on-rails-works.md (1)
38-38: Clear Separation Before Custom Build Instructions
The added newline prior to the listing of custom production build steps (after “then you will:”) makes the ensuing instructions easier to follow.docs/misc/doctrine.md (1)
12-12: Improved Visual Separation in 'Optimize for Programmer Happiness'
The blank line inserted after the header helps set apart the introductory text from the following content, enhancing readability.docs/contributor-info/generator-testing.md (2)
5-5: Clarification on Updated Rake Task Command
The change to userake run_rspec:shakapacker_examplesis clear. Ensure that all related documentation and tasks reflect this update consistently.
9-9: Clear Guidance via Config File Reference
Referencing[rakelib/examples_config.yml]directly is helpful for users to understand how additional apps can be generated and tested.docs/contributor-info/pull-requests.md (4)
4-4: Whitespace and Separation Improvement
The additional whitespace on line 4 improves visual separation between sections, which is beneficial for readability.
12-16: Enhanced Checklist Formatting
The checklist items now start on their own lines, making the list easier to follow. This formatting improvement enhances clarity without altering the content.🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Possible missing article found.
Context: ...d entry? For non-doc fixes: - Provide changelog entry in the [unreleased section of the...(AI_HYDRA_LEO_MISSING_A)
22-23: Heading Level Consistency
The header “#### The seven rules of a great git commit message” remains at level 4. For consistency with the surrounding headings, consider changing it to a level-3 header (i.e. “### The seven rules of a great git commit message”).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
22-22: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
40-44: Consistent Link Reference Formatting
The revised bullet points for referencing documentation and source code files improve clarity. Using a relative URL for docs and a full URL for source code references is clear and consistent.docs/contributor-info/linters.md (1)
1-2: Improved Heading Spacing
The addition of a new line after the “# Linters” header enhances readability by providing better visual separation.docs/misc/style.md (5)
1-3: Overall Document Formatting
The introduction and heading modifications in this document are clear. The added line break in line 2 helps to visually separate the title from the subsequent text.
5-8: Consistent List Formatting
The bullet points under the “Code Style” section (lines 5–8) are now uniformly formatted. This makes it easier for readers to follow the guidelines.
9-11: Clear Client-Side Section Presentation
The “Client Side JavaScript and React” section is well formatted and the link to the style guide is clearly presented.🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-~9: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...n. - Anything additional goes next. ## Client Side JavaScript and React - See the [Shakac...(EN_COMPOUND_ADJECTIVE_INTERNAL)
12-22: Well-Structured Style Guidelines
The “Style Guides to Follow” and subsequent coding standards sections are now more visually coherent. The list items and associated links are clearly separated, which aids quick reference.
31-33: Effective ‘Git Usage’ Section Formatting
The “Git Usage” section now displays its checklist items clearly. The step-by-step instructions are easy to follow.docs/javascript/server-rendering-tips.md (3)
1-8: Clear Presentation of Server Rendering Tips
The initial overview and “General Tips” sections are well formatted. The information is organized in clear bullet points that effectively describe server rendering considerations.🧰 Tools
🪛 LanguageTool
[uncategorized] ~7-~7: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...- Your code can't referencedocument. Server side JS execution does not have access to `d...(EN_COMPOUND_ADJECTIVE_INTERNAL)
13-13: Emphasis on CSS Extraction
The statement “- Server bundles must always have CSS Extracted” now stands out clearly. This emphasis is important for deployment best practices.🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...the view helper applies to client and server side code, the best way to do this is to use...(EN_COMPOUND_ADJECTIVE_INTERNAL)
17-20: Code Block Example Clarity
The example code block illustrating calls to setTimeout is formatted correctly. Its presentation helps in understanding the output structure during server rendering.🧰 Tools
🪛 LanguageTool
[uncategorized] ~19-~19: Possible missing comma found.
Context: ...## Troubleshooting Server Rendering 1. First be sure your code works with server ren...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~20-~20: The word “setup” is a noun. The verb is spelled with a white space.
Context: ...ou will also get the whole file used to setup the JavaScript context. ## CSS Server...(NOUN_VERB_CONFUSION)
docs/rails/turbolinks.md (14)
1-7: Comprehensive Update on Turbo Support
The introductory section now clearly cites related PRs and highlights Turbo support. The bullet list items on lines 4–7 accurately direct the reader to relevant historical context and feature capabilities.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: Possible missing comma found.
Context: ...rbolinks and Turbo Support ## React on Rails Updated to support Turbo, August 2024 ...(AI_HYDRA_LEO_MISSING_COMMA)
9-13: Clear Turbo Configuration Instructions
The “Using Turbo” section clearly explains how to enable Turbo with a concise code snippet (ReactOnRails.setOptions({ turbo: true })). This guidance is easy to follow.🧰 Tools
🪛 LanguageTool
[typographical] ~11-~11: It seems that a comma is missing.
Context: ... obsolete. # Using Turbo To configure Turbo the following option can be set: `React...(IN_ORDER_TO_VB_COMMA)
20-25: Well-Formatted Legacy Turbolinks Section
The “Legacy Turbolinks” section is clearly presented. The bullet points are informative; however, once support for older versions is phased out, consider updating or archiving this section.
26-31: Effective Explanation of Turbolinks Benefits
The “Why Turbolinks?” section succinctly explains performance benefits, and the “Requirements for Using Turbolinks” are clearly enumerated.
48-56: Clear Install Checklist and Code Examples
The “Install Checklist” section is now more structured with code examples clearly demarcated. The guidance on including Turbolinks via yarn or gem is straightforward.
58-64: Good Code Integration Guidance for Application Files
The snippet showing how to add Turbolinks to theapplication.jsfile is concise and helpful. It demonstrates clear usage of the require statement for Turbolinks.
65-70: Concise Overview of Turbolinks 5 Support
The “Turbolinks 5” section accurately informs users about auto-detection and correct event handlers. The link provided for more information is appropriate.
71-78: Clear “Turbolinks from NPM” Instructions and Example
The instructions for installing Turbolinks from NPM, along with the accompanying JavaScript code snippet, are clearly and correctly formatted.
80-88: Detailed Async Script Loading Guidelines
The “Async script loading” section explains both async and defer options with practical examples. The guidance on the workaround usingdeferis especially helpful for addressing issues with component registration during asynchronous loading.
104-113: Clear Troubleshooting and Configuration Snippet
The configuration snippet for turning on Turbolinks event tracing is well presented. This configuration helps in debugging and is a useful addition to the documentation.
115-124: Helpful Webpack DefinePlugin Example
The DefinePlugin example is detailed and demonstrates how to pass theTRACE_TURBOLINKSvalue during compile time. This is a valuable reference for users needing custom builds.
132-141: Well-Illustrated Console Output Examples
The code blocks showing console output for both Turbolinks Classic and Turbolinks 5 provide clear expectations for users. They are helpful in verifying correct configuration.
142-148: Comprehensive Turbolinks 5 Example
The Turbolinks 5 example further clarifies the expected console output after configuration. This reinforces the documentation’s clarity and precision.
150-153: Final Remarks on jQuery and Turbolinks Compatibility
The closing notes regarding potential conflicts when using the Ruby gem version of jQuery are a thoughtful addition. The inclusion of the illustrative image (with its URL) enhances user understanding.🧰 Tools
🪛 LanguageTool
[uncategorized] ~150-~150: A comma may be missing after the conjunctive/linking adverb ‘Therefore’.
Context: ...y gem version of jQuery and jQuery ujs. Therefore we recommend using the node packages in...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
docs/api/view-helpers-api.md (5)
7-8: Consistent Use of Horizontal Separators
The updated horizontal rule (line 7, “---”) now clearly separates the header from the subsequent content, enhancing the document’s readability.
18-20: Clear Presentation of Code Examples
The Ruby code block demonstrating thereact_componentusage (lines 11–16) is well formatted. The subsequent “Uncommonly used options:” section now stands out clearly from the code.
42-43: Separation Between Sections
The horizontal rule at lines 42–43 further delineates distinct documentation sections, ensuring that related content is grouped logically.
81-82: Enhanced Section Demarcation
The horizontal separator inserted at lines 81–82 helps to visually segment the “react_component_hash” section from later sections, making the document easier to scan.
96-102: Overall Documentation Readability
The formatting changes throughout the file—with improved spacing, clear separators, and well-organized code blocks—contribute to a more accessible reference document for users.🧰 Tools
🪛 LanguageTool
[uncategorized] ~100-~100: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... you want to see the server side or the client side rails_context. Typically, for computing...(EN_COMPOUND_ADJECTIVE_INTERNAL)
docs/getting-started.md (5)
1-4: Introduction and Header Clarity
The “Getting Started” section now opens with clearer structure and appropriate spacing, which enhances the initial readability for new users.
7-11: Reordered List Items and Updated Links
The list now clearly distinguishes the tutorial steps. The update from “3.” to “4.” (line 10) along with the added live example link improves guidance. Please verify that the new URL for the full-featured example is correct.
51-57: Server Rendering Instructions Clarity
The note advising use ofNodeas the JS runtime (line 53) is now better separated from the rest of the instructions, ensuring that this important detail isn’t missed.
72-75: Improved Bullet List Formatting for Configuration
The reordering and formatting of the bullet list items (lines 72–75) make the configuration instructions in “Basic Installation” more coherent. This revised structure should help users follow the steps more intuitively.
108-116: Consistent Code Example Presentation
The ERB and JavaScript code blocks now follow a consistent style, which improves both readability and maintainability in the documentation.docs/guides/how-to-use-different-files-for-client-and-server-rendering.md (4)
1-6: Clear Overview and Section Header
The introductory section and header (“How to use different versions of a file for client and server rendering”) are clear and immediately convey the document’s intent.
6-8: Detailed Entry Point Examples
The explanation of having different entry points for client and server rendering (lines 6–8) is well written. The code snippet for the Client Entry (lines 11–15) is concise and illustrative.
28-32: Additional Webpack Resolve Alias Details
The inclusion of the reference to Webpack Docs and subsequent instructions (lines 28–32) add useful context for users needing to customize file resolutions.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
31-31: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
95-101: Client-Only Conditional Code Example
The final code block demonstrating conditional execution based on the existence ofwindow(lines 95–101) is a good, practical example of handling client-only code. The inline comment reinforces the intended behavior on the server.docs/guides/file-system-based-automated-bundle-generation.md (6)
1-4: Improved Introduction and Context
The introductory section clearly explains the requirements for using file-system-based automated bundle generation, and the references to Shakapacker versions and migration guides are useful for users needing context.
7-11: Enhanced Configuration Instructions for Nested Entries
The explanation for enablingnested_entriesinshakapacker.yml(lines 7–11) is well clarified with an example. This adjustment makes it easier for developers to follow along with the configuration steps.
21-24: Clear Instructions for Configuring Components Subdirectory
The updated section on configuring thecomponents_subdirectory(lines 21–24) now presents the instructions more clearly, ensuring that users understand how and where to specify the directory for auto-registration of components.
49-56: Updated .gitignore Guidance and Server Bundle Instructions
The revised guidance on updating.gitignore(lines 49–56) and the code block showing how an import statement is added to the server bundle entrypoint (lines 57–66) are both clear and practically useful.
154-159: Refined Layout Example in ERB
The new ERB code block example (lines 154–159) illustrating the adjusted layout without auto-generated bundles is concise and greatly improves the clarity of the instructions for users who wish to control bundle loading manually.
164-178: Detailed Directory Structure Documentation
The directory structure example (lines 164–178) is well organized and clearly demonstrates how components will be auto-registered when placed in the configured subdirectory. This level of detail is very useful for developers setting up their projects.docs/guides/i18n.md (7)
1-4: Clear Introduction to Internationalization
The introductory lines provide a good overview of how React on Rails integrates with Rails i18n. The brief description and link to the official Rails i18n guide set the right context.
7-10: Improved Code Block for Setting i18n Directory
The instructions and example for settingconfig.i18n_dir(lines 7–10) are now formatted with proper indentation. This makes it easier to read and follow the setup process.
12-18: Clear Example for i18n YAML Directory Configuration
The updated code block for configuringconfig.i18n_yml_dir(lines 12–18) is straightforward and well documented. The inline comment effectively reminds users to replace the placeholder paths with their actual directory locations.
24-28: Enhanced Guidance for Adjusting Startup Scripts
The additional notes on adjusting startup scripts (lines 24–28) are now set off more clearly, ensuring that developers are aware of the need to build locales before linting or starting webpack.
37-40: Configuration of Safe YAML Load Options
The new block showing how to configureconfig.i18n_yml_safe_load_options(lines 37–40) is a useful addition. It provides clarity for users encountering issues with unsafe YAML content.
45-49: Setting the i18n Output Format
The code block for settingconfig.i18n_output_format(lines 45–49) is clear and concise. This small but important detail ensures that users can easily switch the output format as needed.
52-60: Dependency Declaration and Initialization Example for react-intl
The updated snippet showing the required dependencies (lines 52–60) and the subsequent JavaScript initialization code (lines 61–83) forreact-intlare well formatted, enhancing both clarity and consistency in the instructions.docs/javascript/capistrano-deployment.md (2)
3-3: Enhanced Clarity in Environment Description
Changing “in development environment” to “in the development environment” improves clarity.
7-11: Consistent Code Block Language Identifiers
The updates to remove the space in “ruby” (now “ruby”) ensure better syntax highlighting and consistency.docs/rails/rails-engine-integration.md (1)
3-4: Clear Section Headings for Engine Integration
The list items outlining where to insert configuration code (initializer, gemspec, entry point) are clear and well formatted.docs/additional-details/recommended-project-structure.md (3)
18-19: New Section Heading for Client Directory Conversion
Adding the header “## Steps to convert from the generator defaults to use a/clientdirectory for source code” clearly distinguishes this new set of instructions.
29-30: YAML Snippet Formatting Looks Good
The update in the YAML snippet (showing “source_path: client”) aligns with the new project structure guidance.
36-38: Updated Package Delegation Instructions
The additional step to create a/package.jsonthat delegates to/client/package.jsonis clear. Ensure that all users understand this indirection.docs/javascript/react-router.md (1)
10-12: Simplified Import Statements are Clear
The updated import statements forBrowserRouter,Switch, androutesare formatted correctly.NEWS.md (1)
27-29: Duplicate Event Entry Detected
There appear to be two very similar entries dated 2016-11-03 describing the same event. Please verify if this duplication is intentional; if not, consider consolidating the entries.🧰 Tools
🪛 LanguageTool
[inconsistency] ~29-~29: Did you mean to refer to the current year? November 10, 2025 is not a Thursday, but a Monday.
Context: ...) - 2016-11-03: Spoke at [LA Ruby, 7pm, Thursday, November 10 in Venice, CA: "React on Rails: Why, Wh...(EN_DATE_WEEKDAY_CURRENTYEAR)
docs/guides/tutorial.md (3)
3-3: LGTM! Consistent text formatting changes.The changes properly italicize notes and information blocks for better readability and consistent formatting throughout the document.
Also applies to: 7-7, 10-10
16-18: LGTM! Markdown list formatting improvements.These changes improve the formatting consistency of the Markdown lists, which aligns with the PR objective of standardizing formatting across all supported file types.
Also applies to: 22-23, 27-39
46-50: LGTM! Consistent heading and list formatting.These formatting improvements maintain proper spacing after headings and consistent list formatting throughout the document.
docs/outdated/rails-assets-relative-paths.md (3)
1-1: LGTM! Note properly italicized.This formatting change improves the visual distinction of the note at the top of the document.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1-1: Emphasis used instead of a heading
null(MD036, no-emphasis-as-heading)
40-40: LGTM! Consistent string delimiters.Changed double quotes to single quotes in JavaScript examples, following consistent string delimiter conventions.
Also applies to: 64-64, 72-72, 84-84
137-137: LGTM! Added trailing commas.Added trailing commas in JavaScript objects for more consistent formatting and easier future modifications.
Also applies to: 141-141, 156-157, 185-189
node_package/src/reactHydrateOrRender.ts (2)
1-47: LGTM! Improved function signature formatting.The function declaration has been reformatted from single-line to multi-line for better readability, particularly for the
reactHydrateOrRenderfunction (lines 41-47).🧰 Tools
🪛 Biome (1.9.4)
[error] 38-38: Do not depend on the value returned by the function ReactDOM.render().
The returned value is legacy and future versions of React might return that value asynchronously.
Check the React documentation for more information.(lint/correctness/noRenderReturnValue)
38-38: Consider refactoring the legacy render return value usage.While the code includes an ESLint disable comment, the usage of
ReactDOM.render's return value is discouraged as it's a legacy pattern. Future versions of React might return this value asynchronously.🧰 Tools
🪛 Biome (1.9.4)
[error] 38-38: Do not depend on the value returned by the function ReactDOM.render().
The returned value is legacy and future versions of React might return that value asynchronously.
Check the React documentation for more information.(lint/correctness/noRenderReturnValue)
PROJECTS.md (2)
3-3: LGTM! Consistent text formatting.Properly italicized the note on line 10 and formatted the URL on line 3 for improved readability and consistency.
Also applies to: 10-10
14-39: LGTM! Consistent Markdown list formatting.All list items now have consistent formatting with proper indentation and spacing, improving the document's overall readability.
Also applies to: 42-50, 58-61
🧰 Tools
🪛 LanguageTool
[uncategorized] ~15-~15: You might be missing the article “a” here.
Context: ...eals](https://www.redflagdeals.com/)**, Canadian shopping site. - **[YourMechanic](https...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[uncategorized] ~22-~22: You might be missing the article “a” here.
Context: ...](https://www.kisskissbankbank.com/)**, large French crowdfunding platform. - **[HVMN...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[misspelling] ~29-~29: This word is normally spelled as one.
Context: ...has gone live with React on Rails, with multi-lingual JavaScript support! ![2016-05-03_19-1...(EN_COMPOUNDS_MULTI_LINGUAL)
docs/javascript/react-helmet.md (2)
31-34: JSX Syntax Simplification
The updated snippet now removes extraneous parentheses:- export default (props) => (<App {...props} />); + export default (props) => <App {...props} />;This simplification improves readability.
75-80: Trailing Comma in Component Registration
The update in the registration call now includes a trailing comma:- ReactOnRails.register({ ReactHelmetApp }); + ReactOnRails.register({ ReactHelmetApp, });This slight change is consistent with modern formatting standards and looks good.
docs/guides/hmr-and-hot-reloading-with-the-webpack-dev-server.md (1)
13-15: Improved Emphasis on Negation
The change to use not in “If you are not using server-side rendering (not usingprerender: true)” increases emphasis and is in line with the formatting updates.docs/guides/upgrading-react-on-rails.md (3)
3-5: New Migration Help Section Addition
The added guidance in the "Need Help Migrating?" section provides clear contact details and helpful context for users needing migration assistance.
11-13: Clear “Breaking Change” Explanation
The explanation about switching from thewebpackergem toshakapackeris concise and clear. No further action is needed.
33-35: Removed Configuration Notice is Clear
The instructions for removing the deprecatedconfig.symlink_non_digested_assets_regexare straightforward and useful.docs/release-notes/15.0.0.md (2)
6-7: New React Server Components Section
The newly added section on React Server Components effectively introduces the benefits and requirements. This addition enhances the release notes by pointing out cutting‐edge features.
36-48: Async Hydration Function Update is Well Illustrated
The updated instructions showing thatReactOnRails.reactOnRailsPageLoaded()is now asynchronous are clear and include a helpful before/after code example.spec/dummy/README.md (4)
3-4: Enhanced Yalc and Yarn Instructions
The updated bullet points for linking thenode_modulesinspec/dummy/clientand the installation steps add clarity to the setup process.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...e spec/dummy/client/node_modules to the top level - Be sure to install yarn dependencies ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
25-25: Streamlined Yarn Command
The revised commandyarn run dummy:installsimplifies the installation step and makes the README more user friendly.
39-41: Static Loading Command Clarity
The code block for starting the static assets server withforeman start -f Procfile.dev-staticis clear and succinct.
45-47: Test Asset Creation Step
The instructions for creating assets for tests (usingProcfile.spec) are clearly formatted and easy to follow.spec/dummy/client/README.md (1)
3-5: Consistent ESLint Section Heading
The update to the "ESLint" heading and associated explanation improves the document’s clarity. Ensure that the header hierarchy remains consistent with the parent README.KUDOS.md (1)
1-4: KUDOS Document Expansion
The additions to the timeline and quotes enhance the documentation by providing a rich historical perspective of user feedback. The layout is engaging and well structured.
|
|
||
| ## Travis and Gemfiles | ||
| We are currently using Travis for CI. Because of the way Travis works, it is not possible to `bundle install` multiple Gemfiles. Therefore, we have placed all dependencies for generated apps in the gem's main Gemfile. If you generate an app that has a new gem dependency in its Gemfile, you need to add that dependency to the main Gemfile or it will not work in CI. |
There was a problem hiding this comment.
is this section removed intentionally?
There was a problem hiding this comment.
Yes, because we aren't using Travis anymore.
Summary
TypeScript and YAML were not included in
nps format.*scripts.This PR:
--checkinstead of--list-differentfor more readable output.Pull Request checklist
Add/update test to cover these changesUpdate documentationUpdate CHANGELOG fileOther information
Recommended to hide whitespace changes while reviewing.
This change is
Summary by CodeRabbit
Summary by CodeRabbit
New Features
Chores