PS-1280 [FIX] add Fliplet.encode and decode for query params#208
PS-1280 [FIX] add Fliplet.encode and decode for query params#208
Conversation
WalkthroughAdded an "Encoding URL" section to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: ASSERTIVE Plan: Pro 📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/API/core/encode.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/API/core/encode.md
[uncategorized] ~12-~12: Possible missing article found.
Context: ...is used to doubly encode the url. So if browser is automatically parsing double encodin...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~12-~12: Possible missing comma found.
Context: ...the url. So if browser is automatically parsing double encoding ensures that browser pa...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~12-~12: Did you mean “affect” (have an effect upon)?
Context: ...ng ensures that browser parsing doesn't effect the result. ```js var encodedUrl = Fli...
(AFFECT_EFFECT)
[misspelling] ~25-~25: Did you mean “affect” (have an effect upon)?
Context: ...ly decode the url. This method will not effect the decoded URL. Please see the example...
(AFFECT_EFFECT)
🪛 markdownlint-cli2 (0.18.1)
docs/API/core/encode.md
9-9: Trailing spaces
Expected: 0; Actual: 1
(MD009, no-trailing-spaces)
9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
10-10: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
19-19: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
24-24: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
32-32: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/API/core/encode.md (1)
9-16: Fix heading spacing and grammar in the encode section.Headings need blank lines,
URLmust be capitalised, and the copy should read clearly (“double-encodes”, “the browser”, “affect”). Please update this block accordingly.Apply this diff:
-## Encoding URL -### Encode url query parameters - -This method is used to doubly encode the url. So if browser is automatically parsing double encoding ensures that browser parsing doesn't effect the result. +## Encoding URL + +### Encode URL query parameters + +This method double-encodes the URL. If the browser automatically parses the query string, double encoding ensures that parsing does not affect the result.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/API/core/encode.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/API/core/encode.md
[uncategorized] ~12-~12: Possible missing article found.
Context: ...is used to doubly encode the url. So if browser is automatically parsing double encodin...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~12-~12: Possible missing comma found.
Context: ...the url. So if browser is automatically parsing double encoding ensures that browser pa...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~12-~12: Did you mean “affect” (have an effect upon)?
Context: ...ng ensures that browser parsing doesn't effect the result. ```js var encodedUrl = Fli...
(AFFECT_EFFECT)
[misspelling] ~60-~60: Did you mean “affect” (have an effect upon)?
Context: ...ly decode the url. This method will not effect the decoded URL. Please see the example...
(AFFECT_EFFECT)
🪛 markdownlint-cli2 (0.18.1)
docs/API/core/encode.md
9-9: Trailing spaces
Expected: 0; Actual: 1
(MD009, no-trailing-spaces)
9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
10-10: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
20-20: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
21-21: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
31-31: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
32-32: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
42-42: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
43-43: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
59-59: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
66-66: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
67-67: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
77-77: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
78-78: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
92-92: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
93-93: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
113-113: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
114-114: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
docs/API/core/encode.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/API/core/encode.md
[uncategorized] ~12-~12: Possible missing article found.
Context: ...is used to doubly encode the url. So if browser is automatically parsing double encodin...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~12-~12: Possible missing comma found.
Context: ...the url. So if browser is automatically parsing double encoding ensures that browser pa...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~12-~12: Did you mean “affect” (have an effect upon)?
Context: ...ng ensures that browser parsing doesn't effect the result. ```js var encodedUrl = Fli...
(AFFECT_EFFECT)
[misspelling] ~60-~60: Did you mean “affect” (have an effect upon)?
Context: ...ly decode the url. This method will not effect the decoded URL. Please see the example...
(AFFECT_EFFECT)
🪛 markdownlint-cli2 (0.18.1)
docs/API/core/encode.md
9-9: Trailing spaces
Expected: 0; Actual: 1
(MD009, no-trailing-spaces)
9-9: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
10-10: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
20-20: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
21-21: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
31-31: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
32-32: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
42-42: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
43-43: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
59-59: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
66-66: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
67-67: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
77-77: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
78-78: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
92-92: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
93-93: Fenced code blocks should be surrounded by blank lines
(MD031, blanks-around-fences)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
Product areas affected
Fliplet CLI
What does this PR do?
Added JS API's for helping Query params encoding and decoding.
JIRA ticket
PS-1280
Summary by CodeRabbit