From 6f868e1c9a4b0a4ec6b3e913d78ccc3a22e79ae4 Mon Sep 17 00:00:00 2001 From: Pratik Mahalle Date: Fri, 16 May 2025 11:45:33 +0530 Subject: [PATCH 1/6] Fix pipelines: [docs] Adjust Vale Doc Linter and Prettier configurations Signed-off-by: Pratik Mahalle --- STYLE.md | 2 +- docs/hacktoberfest/contribution-guide.md | 2 +- package.json | 2 +- src/css/custom.css | 54 ++++++++----- src/pages/concepts/reference/glossary.js | 4 +- src/pages/styles.module.css | 2 +- src/theme/Heading/styles.module.css | 2 +- static/css/code-block-buttons.css | 74 +++++++++--------- vale_styles/Google/AMPM.yml | 2 +- vale_styles/Google/Acronyms.yml | 2 +- vale_styles/Google/Colons.yml | 2 +- vale_styles/Google/Contractions.yml | 2 +- vale_styles/Google/DateFormat.yml | 2 +- vale_styles/Google/Ellipses.yml | 2 +- vale_styles/Google/EmDash.yml | 4 +- vale_styles/Google/EnDash.yml | 8 +- vale_styles/Google/Exclamation.yml | 2 +- vale_styles/Google/FirstPerson.yml | 2 +- vale_styles/Google/Gender.yml | 2 +- vale_styles/Google/GenderBias.yml | 78 +++++++++---------- vale_styles/Google/HeadingPunctuation.yml | 4 +- vale_styles/Google/Headings.yml | 4 +- vale_styles/Google/Latin.yml | 2 +- vale_styles/Google/LyHyphens.yml | 6 +- vale_styles/Google/OptionalPlurals.yml | 4 +- vale_styles/Google/Ordinal.yml | 2 +- vale_styles/Google/OxfordComma.yml | 2 +- vale_styles/Google/Parens.yml | 2 +- vale_styles/Google/Passive.yml | 2 +- vale_styles/Google/Periods.yml | 2 +- vale_styles/Google/Quotes.yml | 2 +- vale_styles/Google/Ranges.yml | 2 +- vale_styles/Google/Semicolons.yml | 4 +- vale_styles/Google/Slang.yml | 4 +- vale_styles/Google/Spacing.yml | 6 +- vale_styles/Google/Spelling.yml | 2 +- vale_styles/Google/Units.yml | 2 +- vale_styles/Google/We.yml | 2 +- vale_styles/Google/Will.yml | 2 +- vale_styles/Google/WordList.yml | 26 +++---- .../reference/glossary/functional-testing.md | 2 +- .../devtools/docs-contrib-guide.md | 2 +- .../version-1.0.0/devtools/server.md | 2 +- .../version-1.0.0/go/quickstart/echo-sql.md | 2 +- .../version-1.0.0/go/supported-frameworks.md | 2 +- .../hacktoberfest/contribution-guide.md | 2 +- .../version-1.0.0/keploy-explained/faq.md | 2 +- .../version-1.0.0/typescript/installation.md | 2 +- versioned_docs/version-2.0.0/ci-cd/github.md | 6 +- .../version-2.0.0/concepts/installation.md | 2 +- .../reference/glossary/black-box-testing.md | 2 +- .../glossary/software-testing-life-cycle.md | 2 +- .../concepts/reference/glossary/stubs.md | 2 +- .../reference/glossary/white-box-testing.md | 2 +- .../version-2.0.0/dependencies/http.md | 2 +- .../hacktoberfest/contribution-guide.md | 2 +- .../keploy-cloud/deduplication.md | 2 +- .../keploy-cloud/mock-registry.md | 2 +- .../keploy-cloud/testgeneration.md | 2 +- .../keploy-cloud/time-freezing.md | 2 +- .../quickstart/node-express-mongoose.md | 2 +- .../quickstart/sample-rust-crud-mongo.md | 2 +- .../version-2.0.0/quickstart/samples-echo.md | 2 +- .../quickstart/samples-go-sse-svelte.md | 2 +- .../quickstart/samples-node-mongo.md | 2 +- .../running-keploy/unit-test-generator.md | 4 +- .../server/sdk-installation/python.md | 2 +- .../version-1.0.0-sidebars.json | 9 +-- versions.json | 5 +- 69 files changed, 205 insertions(+), 201 deletions(-) diff --git a/STYLE.md b/STYLE.md index 01852911e..e6cb92965 100644 --- a/STYLE.md +++ b/STYLE.md @@ -26,7 +26,7 @@ If you use an en dash in one range, use en dashes in all ranges. Do not mix words and en dashes (or hyphens, for that matter). - Correct: "5 to 10 GB" -- Correct: "5–10 GB" +- Correct: "5-10 GB" - Correct: "5-10 GB" - Incorrect: "from 5-10 GB" diff --git a/docs/hacktoberfest/contribution-guide.md b/docs/hacktoberfest/contribution-guide.md index 321a1ab86..116ed4dfa 100644 --- a/docs/hacktoberfest/contribution-guide.md +++ b/docs/hacktoberfest/contribution-guide.md @@ -18,7 +18,7 @@ If you’ve ever wanted to contribute to open source, now is your chance! You ca Anyone around the globe who desires to help drive the growth of open source and make positive contributions to an ever-growing community. All backgrounds and skill levels are encouraged to participate. -- Code Contributribution to Keploy Projects includes: +- Code Contribution to Keploy Projects includes: - Bug fixes - New features diff --git a/package.json b/package.json index 13522b2d8..7ebb582e7 100644 --- a/package.json +++ b/package.json @@ -60,7 +60,7 @@ "postcss": "^8.4.4", "postcss-import": "^14.0.2", "postcss-preset-env": "^7.4.1", - "prettier": "^2.5.1", + "prettier": "^2.8.8", "prettier-plugin-tailwindcss": "^0.1.4", "rimraf": "^6.0.1", "tailwindcss": "^3.0.1" diff --git a/src/css/custom.css b/src/css/custom.css index 6ec819b4d..2c0296a8d 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -12,19 +12,19 @@ :root { /* Hotfix: Changed primary color to black to resolve conflict with Docusaurus' default primary orange after disabling Tailwind preflight CSS. Added font size and line height adjustments to compensate for the removal of Tailwind preflight. */ - + /* --ifm-color-primary-lighter: #ffb575; */ - font-size:18px; + font-size: 18px; line-height: 1.6; --ifm-color-primary: #000; - --ifm-color-primary-lighter: #FFF; + --ifm-color-primary-lighter: #fff; --ifm-color-primary: #ff914d; --ifm-color-primary-dark: #e67643; --ifm-color-primary-darker: #c95919; --ifm-color-primary-darkest: #be2c1b; --ifm-color-primary-light: #ffd0a0; - + --ifm-color-primary-lightest: #ffceb1; --ifm-code-font-size: 95%; --doc-sidebar-width: 275px !important; @@ -36,11 +36,10 @@ html[data-theme="dark"] { /* Hotfix: Changed 'ifm-color-primary-lighter' to white to resolve conflict with Docusaurus' default color after disabling Tailwind preflight CSS. */ - /* --ifm-color-primary-lighter: #ffb575; */ - --ifm-color-primary-lighter: #FFF; - + --ifm-color-primary-lighter: #fff; + --ifm-color-primary: #ff914d; --ifm-color-primary-dark: #e67643; --ifm-color-primary-darker: #c95919; @@ -111,7 +110,7 @@ html[data-theme="light"] { } /* Hotfix: Remove extra margin-bottom on community links subtext in the home page due to Tailwind preflight removal */ -h3{ +h3 { margin-bottom: 0.1rem; } h1, @@ -120,9 +119,21 @@ h3, h4, .menu__list, .navbar { - font-family: "Aeonik", system-ui, -apple-system, BlinkMacSystemFont, - "Segoe UI", Roboto, "Helvetica Neue", Arial, "Noto Sans", sans-serif, - "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; + font-family: + "Aeonik", + system-ui, + -apple-system, + BlinkMacSystemFont, + "Segoe UI", + Roboto, + "Helvetica Neue", + Arial, + "Noto Sans", + sans-serif, + "Apple Color Emoji", + "Segoe UI Emoji", + "Segoe UI Symbol", + "Noto Color Emoji"; } .menu__list { @@ -334,7 +345,7 @@ footer svg { } /* Reset margin bottom on h3 (refer docs community section li item heading) after disabling tailwind preflight. */ -h3{ +h3 { margin-bottom: 1px; } @@ -583,13 +594,14 @@ a[class="breadcrumbs__link"] { } /* Hotfix: Manually add Tailwind preflight styles to fix clipboard issues in Safari. - Using `preflight: true` caused style conflicts, so these styles are directly included here. */*, + Using `preflight: true` caused style conflicts, so these styles are directly included here. */ +*, ::before, ::after { box-sizing: border-box; border-width: 0; border-style: solid; - border-color: theme('borderColor.DEFAULT', currentColor); + border-color: theme("borderColor.DEFAULT", currentColor); } * { @@ -602,7 +614,7 @@ html { -webkit-text-size-adjust: 100%; -moz-tab-size: 4; tab-size: 4; - font-family: theme('fontFamily.sans', ui-sans-serif, system-ui, sans-serif); + font-family: theme("fontFamily.sans", ui-sans-serif, system-ui, sans-serif); } body { @@ -656,9 +668,9 @@ html { } button, -[type='button'], -[type='reset'], -[type='submit'] { +[type="button"], +[type="reset"], +[type="submit"] { -webkit-appearance: button; background-color: transparent; background-image: none; @@ -685,12 +697,12 @@ menu { } :focus-visible { - outline: 2px solid theme('colors.blue.600', #2563eb); + outline: 2px solid theme("colors.blue.600", #2563eb); outline-offset: 2px; } -[type='number']::-webkit-inner-spin-button, -[type='number']::-webkit-outer-spin-button { +[type="number"]::-webkit-inner-spin-button, +[type="number"]::-webkit-outer-spin-button { height: auto; } diff --git a/src/pages/concepts/reference/glossary.js b/src/pages/concepts/reference/glossary.js index c65676ae7..3c3e4d0d2 100644 --- a/src/pages/concepts/reference/glossary.js +++ b/src/pages/concepts/reference/glossary.js @@ -165,8 +165,8 @@ function Glossary() { state[String.fromCharCode(65 + i)] ? "text-black-200 rounded-3xl bg-orange-200 font-bold shadow-md hover:text-orange-950 dark:text-orange-900" : entries[String.fromCharCode(65 + i)] === undefined - ? "bg-transparent text-gray-400" // Modified color class - : "bg-grey-200 rounded-3xl shadow-md" + ? "bg-transparent text-gray-400" // Modified color class + : "bg-grey-200 rounded-3xl shadow-md" } `} key={i} disabled={ diff --git a/src/pages/styles.module.css b/src/pages/styles.module.css index bae51321e..70eac6e9d 100644 --- a/src/pages/styles.module.css +++ b/src/pages/styles.module.css @@ -159,4 +159,4 @@ .announcementInner { margin: 0 auto; max-width: 768px; -} \ No newline at end of file +} diff --git a/src/theme/Heading/styles.module.css b/src/theme/Heading/styles.module.css index ba959ca0e..9cd0e73c2 100644 --- a/src/theme/Heading/styles.module.css +++ b/src/theme/Heading/styles.module.css @@ -19,7 +19,7 @@ See https://twitter.com/JoshWComeau/status/1332015868725891076 } :global(.hash-link::before) { - content: '#'; + content: "#"; } :global(.hash-link:focus), diff --git a/static/css/code-block-buttons.css b/static/css/code-block-buttons.css index 3440bb7df..6e295df35 100644 --- a/static/css/code-block-buttons.css +++ b/static/css/code-block-buttons.css @@ -1,39 +1,39 @@ /* "Copy" code block button */ pre { - position: relative; - } - - pre .btnIcon { - position: absolute; - top: 4px; - z-index: 2; - cursor: pointer; - border: 1px solid transparent; - padding: 0; - color: #fff; - background-color: transparent; - height: 30px; - transition: all .25s ease-out; - } - - pre .btnIcon:hover { - text-decoration: none; - } - - .btnIcon__body { - align-items: center; - display: flex; - } - - .btnIcon svg { - fill: currentColor; - margin-right: .4em; - } - - .btnIcon__label { - font-size: 11px; - } - - .btnClipboard { - right: 10px; - } \ No newline at end of file + position: relative; +} + +pre .btnIcon { + position: absolute; + top: 4px; + z-index: 2; + cursor: pointer; + border: 1px solid transparent; + padding: 0; + color: #fff; + background-color: transparent; + height: 30px; + transition: all 0.25s ease-out; +} + +pre .btnIcon:hover { + text-decoration: none; +} + +.btnIcon__body { + align-items: center; + display: flex; +} + +.btnIcon svg { + fill: currentColor; + margin-right: 0.4em; +} + +.btnIcon__label { + font-size: 11px; +} + +.btnClipboard { + right: 10px; +} diff --git a/vale_styles/Google/AMPM.yml b/vale_styles/Google/AMPM.yml index fbdc6e4f8..518e1d4dc 100644 --- a/vale_styles/Google/AMPM.yml +++ b/vale_styles/Google/AMPM.yml @@ -1,6 +1,6 @@ extends: existence message: "Use 'AM' or 'PM' (preceded by a space)." -link: 'https://developers.google.com/style/word-list' +link: "https://developers.google.com/style/word-list" level: error nonword: true tokens: diff --git a/vale_styles/Google/Acronyms.yml b/vale_styles/Google/Acronyms.yml index f41af0189..acfa940d2 100644 --- a/vale_styles/Google/Acronyms.yml +++ b/vale_styles/Google/Acronyms.yml @@ -1,6 +1,6 @@ extends: conditional message: "Spell out '%s', if it's unfamiliar to the audience." -link: 'https://developers.google.com/style/abbreviations' +link: "https://developers.google.com/style/abbreviations" level: suggestion ignorecase: false # Ensures that the existence of 'first' implies the existence of 'second'. diff --git a/vale_styles/Google/Colons.yml b/vale_styles/Google/Colons.yml index 99363fbd4..fcbeaa798 100644 --- a/vale_styles/Google/Colons.yml +++ b/vale_styles/Google/Colons.yml @@ -1,6 +1,6 @@ extends: existence message: "'%s' should be in lowercase." -link: 'https://developers.google.com/style/colons' +link: "https://developers.google.com/style/colons" nonword: true level: warning scope: sentence diff --git a/vale_styles/Google/Contractions.yml b/vale_styles/Google/Contractions.yml index 95234987b..4dd4c258f 100644 --- a/vale_styles/Google/Contractions.yml +++ b/vale_styles/Google/Contractions.yml @@ -1,6 +1,6 @@ extends: substitution message: "Feel free to use '%s' instead of '%s'." -link: 'https://developers.google.com/style/contractions' +link: "https://developers.google.com/style/contractions" level: suggestion ignorecase: true action: diff --git a/vale_styles/Google/DateFormat.yml b/vale_styles/Google/DateFormat.yml index e9d227fa1..168aa4c57 100644 --- a/vale_styles/Google/DateFormat.yml +++ b/vale_styles/Google/DateFormat.yml @@ -1,6 +1,6 @@ extends: existence message: "Use 'July 31, 2016' format, not '%s'." -link: 'https://developers.google.com/style/dates-times' +link: "https://developers.google.com/style/dates-times" ignorecase: true level: error nonword: true diff --git a/vale_styles/Google/Ellipses.yml b/vale_styles/Google/Ellipses.yml index 1e070517b..4e906228e 100644 --- a/vale_styles/Google/Ellipses.yml +++ b/vale_styles/Google/Ellipses.yml @@ -1,6 +1,6 @@ extends: existence message: "In general, don't use an ellipsis." -link: 'https://developers.google.com/style/ellipses' +link: "https://developers.google.com/style/ellipses" nonword: true level: warning action: diff --git a/vale_styles/Google/EmDash.yml b/vale_styles/Google/EmDash.yml index 1befe72aa..9cb0464e1 100644 --- a/vale_styles/Google/EmDash.yml +++ b/vale_styles/Google/EmDash.yml @@ -1,12 +1,12 @@ extends: existence message: "Don't put a space before or after a dash." -link: 'https://developers.google.com/style/dashes' +link: "https://developers.google.com/style/dashes" nonword: true level: error action: name: edit params: - remove - - ' ' + - " " tokens: - '\s[—–]\s' diff --git a/vale_styles/Google/EnDash.yml b/vale_styles/Google/EnDash.yml index b314dc4e9..ec23a87ab 100644 --- a/vale_styles/Google/EnDash.yml +++ b/vale_styles/Google/EnDash.yml @@ -1,13 +1,13 @@ extends: existence message: "Use an em dash ('—') instead of '–'." -link: 'https://developers.google.com/style/dashes' +link: "https://developers.google.com/style/dashes" nonword: true level: error action: name: edit params: - replace - - '-' - - '—' + - "-" + - "—" tokens: - - '–' + - "–" diff --git a/vale_styles/Google/Exclamation.yml b/vale_styles/Google/Exclamation.yml index 3e15181b2..e10c3263b 100644 --- a/vale_styles/Google/Exclamation.yml +++ b/vale_styles/Google/Exclamation.yml @@ -1,6 +1,6 @@ extends: existence message: "Don't use exclamation points in text." -link: 'https://developers.google.com/style/exclamation-points' +link: "https://developers.google.com/style/exclamation-points" nonword: true level: error tokens: diff --git a/vale_styles/Google/FirstPerson.yml b/vale_styles/Google/FirstPerson.yml index 0b7b8828c..21a074dce 100644 --- a/vale_styles/Google/FirstPerson.yml +++ b/vale_styles/Google/FirstPerson.yml @@ -1,6 +1,6 @@ extends: existence message: "Avoid first-person pronouns such as '%s'." -link: 'https://developers.google.com/style/pronouns#personal-pronouns' +link: "https://developers.google.com/style/pronouns#personal-pronouns" ignorecase: true level: warning nonword: true diff --git a/vale_styles/Google/Gender.yml b/vale_styles/Google/Gender.yml index c8486181d..5eda946ba 100644 --- a/vale_styles/Google/Gender.yml +++ b/vale_styles/Google/Gender.yml @@ -1,6 +1,6 @@ extends: existence message: "Don't use '%s' as a gender-neutral pronoun." -link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns' +link: "https://developers.google.com/style/pronouns#gender-neutral-pronouns" level: error ignorecase: true tokens: diff --git a/vale_styles/Google/GenderBias.yml b/vale_styles/Google/GenderBias.yml index 261cfb666..8a21b5c75 100644 --- a/vale_styles/Google/GenderBias.yml +++ b/vale_styles/Google/GenderBias.yml @@ -1,45 +1,45 @@ extends: substitution message: "Consider using '%s' instead of '%s'." -link: 'https://developers.google.com/style/inclusive-documentation' +link: "https://developers.google.com/style/inclusive-documentation" ignorecase: true level: error swap: - (?:alumna|alumnus): graduate - (?:alumnae|alumni): graduates - air(?:m[ae]n|wom[ae]n): pilot(s) - anchor(?:m[ae]n|wom[ae]n): anchor(s) - authoress: author - camera(?:m[ae]n|wom[ae]n): camera operator(s) - chair(?:m[ae]n|wom[ae]n): chair(s) + (?:alumna|alumnus): graduate + (?:alumnae|alumni): graduates + air(?:m[ae]n|wom[ae]n): pilot(s) + anchor(?:m[ae]n|wom[ae]n): anchor(s) + authoress: author + camera(?:m[ae]n|wom[ae]n): camera operator(s) + chair(?:m[ae]n|wom[ae]n): chair(s) congress(?:m[ae]n|wom[ae]n): member(s) of congress - door(?:m[ae]|wom[ae]n): concierge(s) - draft(?:m[ae]n|wom[ae]n): drafter(s) - fire(?:m[ae]n|wom[ae]n): firefighter(s) - fisher(?:m[ae]n|wom[ae]n): fisher(s) - fresh(?:m[ae]n|wom[ae]n): first-year student(s) - garbage(?:m[ae]n|wom[ae]n): waste collector(s) - lady lawyer: lawyer - ladylike: courteous - landlord: building manager - mail(?:m[ae]n|wom[ae]n): mail carriers - man and wife: husband and wife - man enough: strong enough - mankind: human kind - manmade: manufactured - manpower: personnel - men and girls: men and women - middle(?:m[ae]n|wom[ae]n): intermediary - news(?:m[ae]n|wom[ae]n): journalist(s) - ombuds(?:man|woman): ombuds - oneupmanship: upstaging - poetess: poet - police(?:m[ae]n|wom[ae]n): police officer(s) - repair(?:m[ae]n|wom[ae]n): technician(s) - sales(?:m[ae]n|wom[ae]n): salesperson or sales people - service(?:m[ae]n|wom[ae]n): soldier(s) - steward(?:ess)?: flight attendant - tribes(?:m[ae]n|wom[ae]n): tribe member(s) - waitress: waiter - woman doctor: doctor - woman scientist[s]?: scientist(s) - work(?:m[ae]n|wom[ae]n): worker(s) + door(?:m[ae]|wom[ae]n): concierge(s) + draft(?:m[ae]n|wom[ae]n): drafter(s) + fire(?:m[ae]n|wom[ae]n): firefighter(s) + fisher(?:m[ae]n|wom[ae]n): fisher(s) + fresh(?:m[ae]n|wom[ae]n): first-year student(s) + garbage(?:m[ae]n|wom[ae]n): waste collector(s) + lady lawyer: lawyer + ladylike: courteous + landlord: building manager + mail(?:m[ae]n|wom[ae]n): mail carriers + man and wife: husband and wife + man enough: strong enough + mankind: human kind + manmade: manufactured + manpower: personnel + men and girls: men and women + middle(?:m[ae]n|wom[ae]n): intermediary + news(?:m[ae]n|wom[ae]n): journalist(s) + ombuds(?:man|woman): ombuds + oneupmanship: upstaging + poetess: poet + police(?:m[ae]n|wom[ae]n): police officer(s) + repair(?:m[ae]n|wom[ae]n): technician(s) + sales(?:m[ae]n|wom[ae]n): salesperson or sales people + service(?:m[ae]n|wom[ae]n): soldier(s) + steward(?:ess)?: flight attendant + tribes(?:m[ae]n|wom[ae]n): tribe member(s) + waitress: waiter + woman doctor: doctor + woman scientist[s]?: scientist(s) + work(?:m[ae]n|wom[ae]n): worker(s) diff --git a/vale_styles/Google/HeadingPunctuation.yml b/vale_styles/Google/HeadingPunctuation.yml index b538be5b4..7202aa56a 100644 --- a/vale_styles/Google/HeadingPunctuation.yml +++ b/vale_styles/Google/HeadingPunctuation.yml @@ -1,6 +1,6 @@ extends: existence message: "Don't put a period at the end of a heading." -link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' +link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings" nonword: true level: warning scope: heading @@ -8,6 +8,6 @@ action: name: edit params: - remove - - '.' + - "." tokens: - '[a-z0-9][.]\s*$' diff --git a/vale_styles/Google/Headings.yml b/vale_styles/Google/Headings.yml index a53301338..18e2f17f3 100644 --- a/vale_styles/Google/Headings.yml +++ b/vale_styles/Google/Headings.yml @@ -1,11 +1,11 @@ extends: capitalization message: "'%s' should use sentence-style capitalization." -link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings' +link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings" level: warning scope: heading match: $sentence indicators: - - ':' + - ":" exceptions: - Azure - CLI diff --git a/vale_styles/Google/Latin.yml b/vale_styles/Google/Latin.yml index d91700de3..3ad563c45 100644 --- a/vale_styles/Google/Latin.yml +++ b/vale_styles/Google/Latin.yml @@ -1,6 +1,6 @@ extends: substitution message: "Use '%s' instead of '%s'." -link: 'https://developers.google.com/style/abbreviations' +link: "https://developers.google.com/style/abbreviations" ignorecase: true level: error nonword: true diff --git a/vale_styles/Google/LyHyphens.yml b/vale_styles/Google/LyHyphens.yml index ac8f557a4..5c8193491 100644 --- a/vale_styles/Google/LyHyphens.yml +++ b/vale_styles/Google/LyHyphens.yml @@ -1,6 +1,6 @@ extends: existence message: "'%s' doesn't need a hyphen." -link: 'https://developers.google.com/style/hyphens' +link: "https://developers.google.com/style/hyphens" level: error ignorecase: false nonword: true @@ -8,7 +8,7 @@ action: name: edit params: - replace - - '-' - - ' ' + - "-" + - " " tokens: - '\s[^\s-]+ly-' diff --git a/vale_styles/Google/OptionalPlurals.yml b/vale_styles/Google/OptionalPlurals.yml index f858ea6fe..0465e2d8c 100644 --- a/vale_styles/Google/OptionalPlurals.yml +++ b/vale_styles/Google/OptionalPlurals.yml @@ -1,12 +1,12 @@ extends: existence message: "Don't use plurals in parentheses such as in '%s'." -link: 'https://developers.google.com/style/plurals-parentheses' +link: "https://developers.google.com/style/plurals-parentheses" level: error nonword: true action: name: edit params: - remove - - '(s)' + - "(s)" tokens: - '\b\w+\(s\)' diff --git a/vale_styles/Google/Ordinal.yml b/vale_styles/Google/Ordinal.yml index d1ac7d27e..2e75b8dcb 100644 --- a/vale_styles/Google/Ordinal.yml +++ b/vale_styles/Google/Ordinal.yml @@ -1,6 +1,6 @@ extends: existence message: "Spell out all ordinal numbers ('%s') in text." -link: 'https://developers.google.com/style/numbers' +link: "https://developers.google.com/style/numbers" level: error nonword: true tokens: diff --git a/vale_styles/Google/OxfordComma.yml b/vale_styles/Google/OxfordComma.yml index b9ba21ebb..5bd5faf04 100644 --- a/vale_styles/Google/OxfordComma.yml +++ b/vale_styles/Google/OxfordComma.yml @@ -1,6 +1,6 @@ extends: existence message: "Use the Oxford comma in '%s'." -link: 'https://developers.google.com/style/commas' +link: "https://developers.google.com/style/commas" scope: sentence level: warning tokens: diff --git a/vale_styles/Google/Parens.yml b/vale_styles/Google/Parens.yml index 3b8711d0c..7c7eb0fc5 100644 --- a/vale_styles/Google/Parens.yml +++ b/vale_styles/Google/Parens.yml @@ -1,6 +1,6 @@ extends: existence message: "Use parentheses judiciously." -link: 'https://developers.google.com/style/parentheses' +link: "https://developers.google.com/style/parentheses" nonword: true level: suggestion tokens: diff --git a/vale_styles/Google/Passive.yml b/vale_styles/Google/Passive.yml index 3265890e5..b7b1dd225 100644 --- a/vale_styles/Google/Passive.yml +++ b/vale_styles/Google/Passive.yml @@ -1,5 +1,5 @@ extends: existence -link: 'https://developers.google.com/style/voice' +link: "https://developers.google.com/style/voice" message: "In general, use active voice instead of passive voice ('%s')." ignorecase: true level: suggestion diff --git a/vale_styles/Google/Periods.yml b/vale_styles/Google/Periods.yml index d24a6a6c0..9bbf9e81b 100644 --- a/vale_styles/Google/Periods.yml +++ b/vale_styles/Google/Periods.yml @@ -1,6 +1,6 @@ extends: existence message: "Don't use periods with acronyms or initialisms such as '%s'." -link: 'https://developers.google.com/style/abbreviations' +link: "https://developers.google.com/style/abbreviations" level: error nonword: true tokens: diff --git a/vale_styles/Google/Quotes.yml b/vale_styles/Google/Quotes.yml index 3cb6f1abd..44118f942 100644 --- a/vale_styles/Google/Quotes.yml +++ b/vale_styles/Google/Quotes.yml @@ -1,6 +1,6 @@ extends: existence message: "Commas and periods go inside quotation marks." -link: 'https://developers.google.com/style/quotation-marks' +link: "https://developers.google.com/style/quotation-marks" level: error nonword: true tokens: diff --git a/vale_styles/Google/Ranges.yml b/vale_styles/Google/Ranges.yml index 3ec045e77..8469d92e9 100644 --- a/vale_styles/Google/Ranges.yml +++ b/vale_styles/Google/Ranges.yml @@ -1,6 +1,6 @@ extends: existence message: "Don't add words such as 'from' or 'between' to describe a range of numbers." -link: 'https://developers.google.com/style/hyphens' +link: "https://developers.google.com/style/hyphens" nonword: true level: warning tokens: diff --git a/vale_styles/Google/Semicolons.yml b/vale_styles/Google/Semicolons.yml index bb8b85b42..65586ab74 100644 --- a/vale_styles/Google/Semicolons.yml +++ b/vale_styles/Google/Semicolons.yml @@ -1,8 +1,8 @@ extends: existence message: "Use semicolons judiciously." -link: 'https://developers.google.com/style/semicolons' +link: "https://developers.google.com/style/semicolons" nonword: true scope: sentence level: suggestion tokens: - - ';' + - ";" diff --git a/vale_styles/Google/Slang.yml b/vale_styles/Google/Slang.yml index 63f4c248a..802f81968 100644 --- a/vale_styles/Google/Slang.yml +++ b/vale_styles/Google/Slang.yml @@ -1,10 +1,10 @@ extends: existence message: "Don't use internet slang abbreviations such as '%s'." -link: 'https://developers.google.com/style/abbreviations' +link: "https://developers.google.com/style/abbreviations" ignorecase: true level: error tokens: - - 'tl;dr' + - "tl;dr" - ymmv - rtfm - imo diff --git a/vale_styles/Google/Spacing.yml b/vale_styles/Google/Spacing.yml index 27f7ca2bd..dfc27be41 100644 --- a/vale_styles/Google/Spacing.yml +++ b/vale_styles/Google/Spacing.yml @@ -1,8 +1,8 @@ extends: existence message: "'%s' should have one space." -link: 'https://developers.google.com/style/sentence-spacing' +link: "https://developers.google.com/style/sentence-spacing" level: error nonword: true tokens: - - '[a-z][.?!] {2,}[A-Z]' - - '[a-z][.?!][A-Z]' + - "[a-z][.?!] {2,}[A-Z]" + - "[a-z][.?!][A-Z]" diff --git a/vale_styles/Google/Spelling.yml b/vale_styles/Google/Spelling.yml index 57acb8841..3d62d448e 100644 --- a/vale_styles/Google/Spelling.yml +++ b/vale_styles/Google/Spelling.yml @@ -1,6 +1,6 @@ extends: existence message: "In general, use American spelling instead of '%s'." -link: 'https://developers.google.com/style/spelling' +link: "https://developers.google.com/style/spelling" ignorecase: true level: warning tokens: diff --git a/vale_styles/Google/Units.yml b/vale_styles/Google/Units.yml index 379fad6b8..8c2f4c83d 100644 --- a/vale_styles/Google/Units.yml +++ b/vale_styles/Google/Units.yml @@ -1,6 +1,6 @@ extends: existence message: "Put a nonbreaking space between the number and the unit in '%s'." -link: 'https://developers.google.com/style/units-of-measure' +link: "https://developers.google.com/style/units-of-measure" nonword: true level: error tokens: diff --git a/vale_styles/Google/We.yml b/vale_styles/Google/We.yml index c7ac7d362..0fdbf869d 100644 --- a/vale_styles/Google/We.yml +++ b/vale_styles/Google/We.yml @@ -1,6 +1,6 @@ extends: existence message: "Try to avoid using first-person plural like '%s'." -link: 'https://developers.google.com/style/pronouns#personal-pronouns' +link: "https://developers.google.com/style/pronouns#personal-pronouns" level: warning ignorecase: true tokens: diff --git a/vale_styles/Google/Will.yml b/vale_styles/Google/Will.yml index 128a91836..d94cc0492 100644 --- a/vale_styles/Google/Will.yml +++ b/vale_styles/Google/Will.yml @@ -1,6 +1,6 @@ extends: existence message: "Avoid using '%s'." -link: 'https://developers.google.com/style/tense' +link: "https://developers.google.com/style/tense" ignorecase: true level: warning tokens: diff --git a/vale_styles/Google/WordList.yml b/vale_styles/Google/WordList.yml index bb711517e..d89ed39f7 100644 --- a/vale_styles/Google/WordList.yml +++ b/vale_styles/Google/WordList.yml @@ -1,25 +1,25 @@ extends: substitution message: "Use '%s' instead of '%s'." -link: 'https://developers.google.com/style/word-list' +link: "https://developers.google.com/style/word-list" level: warning ignorecase: false action: name: replace swap: - '(?:API Console|dev|developer) key': API key - '(?:cell ?phone|smart ?phone)': phone|mobile phone - '(?:dev|developer|APIs) console': API console - '(?:e-mail|Email|E-mail)': email - '(?:file ?path|path ?name)': path - '(?:kill|terminate|abort)': stop|exit|cancel|end - '(?:OAuth ?2|Oauth)': OAuth 2.0 - '(?:ok|Okay)': OK|okay - '(?:WiFi|wifi)': Wi-Fi + "(?:API Console|dev|developer) key": API key + "(?:cell ?phone|smart ?phone)": phone|mobile phone + "(?:dev|developer|APIs) console": API console + "(?:e-mail|Email|E-mail)": email + "(?:file ?path|path ?name)": path + "(?:kill|terminate|abort)": stop|exit|cancel|end + "(?:OAuth ?2|Oauth)": OAuth 2.0 + "(?:ok|Okay)": OK|okay + "(?:WiFi|wifi)": Wi-Fi '[\.]+apk': APK '3\-D': 3D 'Google (?:I\-O|IO)': Google I/O - 'tap (?:&|and) hold': touch & hold - 'un(?:check|select)': clear + "tap (?:&|and) hold": touch & hold + "un(?:check|select)": clear above: preceding account name: username action bar: app bar @@ -75,6 +75,6 @@ swap: tablename: table name tablet: device touch: tap - url: URL + url: URL vs\.: versus World Wide Web: web diff --git a/versioned_docs/version-1.0.0/concepts/reference/glossary/functional-testing.md b/versioned_docs/version-1.0.0/concepts/reference/glossary/functional-testing.md index b5e2a80ee..2a4675a8d 100644 --- a/versioned_docs/version-1.0.0/concepts/reference/glossary/functional-testing.md +++ b/versioned_docs/version-1.0.0/concepts/reference/glossary/functional-testing.md @@ -13,7 +13,7 @@ Functional testing is a type of software testing that verifies that the software Functional testing is typically performed by providing the software with input data and then checking the output data to see if it matches the expected results. This can be done manually or using automated testing tools. -### Types of Funtional Testing +### Types of Functional Testing There are many different types of functional testing, including: diff --git a/versioned_docs/version-1.0.0/devtools/docs-contrib-guide.md b/versioned_docs/version-1.0.0/devtools/docs-contrib-guide.md index 1f50d86f3..cf4d118b6 100644 --- a/versioned_docs/version-1.0.0/devtools/docs-contrib-guide.md +++ b/versioned_docs/version-1.0.0/devtools/docs-contrib-guide.md @@ -121,7 +121,7 @@ After you have cloned the documentation repo to your computer locally, edit the 3. On Github, click on the `Create a new Pull Request` button. -4. Use a succinct title and descriptive comments to descibe your Pull Request. Also Ensure maintainers can understand your proposed changes from the description +4. Use a succinct title and descriptive comments to describe your Pull Request. Also Ensure maintainers can understand your proposed changes from the description ## How to Suggest UI/UX Improvements? diff --git a/versioned_docs/version-1.0.0/devtools/server.md b/versioned_docs/version-1.0.0/devtools/server.md index 2b9295f05..acb61c8b0 100644 --- a/versioned_docs/version-1.0.0/devtools/server.md +++ b/versioned_docs/version-1.0.0/devtools/server.md @@ -18,7 +18,7 @@ docker-compose -f docker-compose-dev.yaml up --build ``` If you are not using docker, you can build and run the keploy server directly. Ensure to provide the Mongo connection string via the `KEPLOY_MONGO_URI` env variable. And also -enusre that `ENABLE_TEST_EXPORT=false` as by default it is `true` and you will not able to see testcases data in UI so make it `false` if you don't want to export test cases. +ensure that `ENABLE_TEST_EXPORT=false` as by default it is `true` and you will not able to see testcases data in UI so make it `false` if you don't want to export test cases. ```shell export KEPLOY_MONGO_URI="mongodb://mongo:27017" diff --git a/versioned_docs/version-1.0.0/go/quickstart/echo-sql.md b/versioned_docs/version-1.0.0/go/quickstart/echo-sql.md index 35fd2fdcf..fa567b33e 100644 --- a/versioned_docs/version-1.0.0/go/quickstart/echo-sql.md +++ b/versioned_docs/version-1.0.0/go/quickstart/echo-sql.md @@ -79,7 +79,7 @@ curl --request GET \ or by querying through the browser `http://localhost:6789/Lhr4BWAi` -Now both these API calls were captured as a testcase and should be visible in the keploy-tests folderj. +Now both these API calls were captured as a testcase and should be visible in the keploy-tests folder. If you're using Keploy cloud, open [this](https://app.keploy.io/). ![testcases](/img/Echo-Sql-test-cases.png) diff --git a/versioned_docs/version-1.0.0/go/supported-frameworks.md b/versioned_docs/version-1.0.0/go/supported-frameworks.md index 6870a818b..ecfdee343 100644 --- a/versioned_docs/version-1.0.0/go/supported-frameworks.md +++ b/versioned_docs/version-1.0.0/go/supported-frameworks.md @@ -361,7 +361,7 @@ Here is an example for postgres driver and binary encoded outputs - } ``` -> Its compatible with gORM. To integerate with gORM set DisableAutomaticPing of gorm.Config to true. Also pass request context to methods as params. +> Its compatible with gORM. To integrate with gORM set DisableAutomaticPing of gorm.Config to true. Also pass request context to methods as params. > Example for gORM with GCP-Postgres driver: ```go diff --git a/versioned_docs/version-1.0.0/hacktoberfest/contribution-guide.md b/versioned_docs/version-1.0.0/hacktoberfest/contribution-guide.md index 80032b585..71d317a7f 100644 --- a/versioned_docs/version-1.0.0/hacktoberfest/contribution-guide.md +++ b/versioned_docs/version-1.0.0/hacktoberfest/contribution-guide.md @@ -18,7 +18,7 @@ If you’ve ever wanted to contribute to open source, now is your chance! You ca Anyone around the globe who desires to help drive the growth of open source and make positive contributions to an ever-growing community. All backgrounds and skill levels are encouraged to participate. -- Code Contributribution to Keploy Projects includes: +- Code Contribution to Keploy Projects includes: - Bug fixes - New features diff --git a/versioned_docs/version-1.0.0/keploy-explained/faq.md b/versioned_docs/version-1.0.0/keploy-explained/faq.md index 39a26c917..0b54ce7c1 100644 --- a/versioned_docs/version-1.0.0/keploy-explained/faq.md +++ b/versioned_docs/version-1.0.0/keploy-explained/faq.md @@ -9,7 +9,7 @@ tags: ### 1. Is Keploy a unit testing framework? -No, keploy is designed to reduce time writing tests manually. It integrates with exising unit testing frameworks like (eg: go test, Junit, pytest, etc.) to ensure compatibility with existing tooling like code coverage, IDE support and CI pipeline/infrastructure support. +No, keploy is designed to reduce time writing tests manually. It integrates with existing unit testing frameworks like (eg: go test, Junit, pytest, etc.) to ensure compatibility with existing tooling like code coverage, IDE support and CI pipeline/infrastructure support. ### 2. Does Keploy replace unit tests entirely? diff --git a/versioned_docs/version-1.0.0/typescript/installation.md b/versioned_docs/version-1.0.0/typescript/installation.md index 7ab78ea3b..62b5b5321 100644 --- a/versioned_docs/version-1.0.0/typescript/installation.md +++ b/versioned_docs/version-1.0.0/typescript/installation.md @@ -23,7 +23,7 @@ tags: 2. **Test mode** 1. Fetches testcases for the app from keploy server. 2. Calls the API with same request payload in testcase. - 3. Validates the respones and uploads results to the keploy server. + 3. Validates the responses and uploads results to the keploy server. ## Installation diff --git a/versioned_docs/version-2.0.0/ci-cd/github.md b/versioned_docs/version-2.0.0/ci-cd/github.md index 6aa74bfb4..9a5e65fa1 100644 --- a/versioned_docs/version-2.0.0/ci-cd/github.md +++ b/versioned_docs/version-2.0.0/ci-cd/github.md @@ -21,7 +21,7 @@ Keploy can be integrated with GitHub by two methods:- ## Shell Scripts -GitHub scripts are the easiest way to integrate Keploy with GitHub. We will be using [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample-application for the example. You can either add the following script to yout `github workflow` or create a new worflow `.github/workflows/keploy-test.yml`:- +GitHub scripts are the easiest way to integrate Keploy with GitHub. We will be using [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample-application for the example. You can either add the following script to your `github workflow` or create a new workflow `.github/workflows/keploy-test.yml`:- ```yaml - name: Checkout Commit @@ -122,8 +122,8 @@ _And... voila! You have successfully integrated keploy in GitHub CI pipeline ## GitHub Actions -GitHub Actions are a more advanced way to integrate Keploy with GitHub. We will be using [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample-application for the example. Create a new workflow unde `.github/workflow` with the name `keploy-test.yml`: - -GitHub Actions are a more advanced way to integrate Keploy with GitHub. We will be using [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample-application for the example. Create a new workflow unde `.github/workflow` with the name `keploy-test.yml`: - +GitHub Actions are a more advanced way to integrate Keploy with GitHub. We will be using [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample-application for the example. Create a new workflow under `.github/workflow` with the name `keploy-test.yml`: - +GitHub Actions are a more advanced way to integrate Keploy with GitHub. We will be using [express-mongoose](https://github.com/keploy/samples-typescript/tree/main/express-mongoose) sample-application for the example. Create a new workflow under `.github/workflow` with the name `keploy-test.yml`: - ```yaml jobs: diff --git a/versioned_docs/version-2.0.0/concepts/installation.md b/versioned_docs/version-2.0.0/concepts/installation.md index cdd72f03d..23ff18bb7 100644 --- a/versioned_docs/version-2.0.0/concepts/installation.md +++ b/versioned_docs/version-2.0.0/concepts/installation.md @@ -98,7 +98,7 @@ alias keploy="docker run --name keploy-v2 -p 16789:16789 --network keploy-networ ### Downloading and running Keploy in Native -**Prequisites:** +**Prerequisites:** - Linux Kernel version 5.15 or higher - Run `uname -a` to verify the system architecture. diff --git a/versioned_docs/version-2.0.0/concepts/reference/glossary/black-box-testing.md b/versioned_docs/version-2.0.0/concepts/reference/glossary/black-box-testing.md index d2de55a2f..fd1edc3eb 100644 --- a/versioned_docs/version-2.0.0/concepts/reference/glossary/black-box-testing.md +++ b/versioned_docs/version-2.0.0/concepts/reference/glossary/black-box-testing.md @@ -53,7 +53,7 @@ This testing approach is essential for several reasons: 5. **Detection of Defects**: Identifies functional errors, security vulnerabilities, and performance bottlenecks. 6. **Accessibility**: Suitable for testers with diverse backgrounds and skill sets, adaptable to various software applications. -## Whate are types of Black-Box Testing Techniques ? +## What are types of Black-Box Testing Techniques ? ![How Black Box testing Works?](https://www.imperva.com/learn/wp-content/uploads/sites/13/2020/03/thumbnail_Black-box.jpg) diff --git a/versioned_docs/version-2.0.0/concepts/reference/glossary/software-testing-life-cycle.md b/versioned_docs/version-2.0.0/concepts/reference/glossary/software-testing-life-cycle.md index 6ffe1864f..0d10353bf 100644 --- a/versioned_docs/version-2.0.0/concepts/reference/glossary/software-testing-life-cycle.md +++ b/versioned_docs/version-2.0.0/concepts/reference/glossary/software-testing-life-cycle.md @@ -67,7 +67,7 @@ Software Testing Life Cycle (STLC) comprises several phases that guide the testi - **Risk-Based Testing**: Prioritize tests based on potential impact and likelihood of failure. - **Performance Testing**: Evaluate software performance under various conditions and loads. -## How Keploy helps in accelrating the Software Testing Life Cycle process? +## How Keploy helps in accelerating the Software Testing Life Cycle process? Keploy enhances the STLC with its advanced features tailored for modern software testing needs: diff --git a/versioned_docs/version-2.0.0/concepts/reference/glossary/stubs.md b/versioned_docs/version-2.0.0/concepts/reference/glossary/stubs.md index 3822cc436..9190ee9f2 100644 --- a/versioned_docs/version-2.0.0/concepts/reference/glossary/stubs.md +++ b/versioned_docs/version-2.0.0/concepts/reference/glossary/stubs.md @@ -44,7 +44,7 @@ When we talk about stubs, they are a valuable tool in the process of software de - Also, with data stubs may not be able to handle all of the possible scenarios that the real-world system can handle. - Stubs are generally brittle. -## Overcoming Stub Challeges with Keploy: +## Overcoming Stub Challegnes with Keploy: Overall, stubs are a valuable tool for software development and testing. They can help to speed up the development process, ensure that the code is working correctly, and identify problems with the calling module. diff --git a/versioned_docs/version-2.0.0/concepts/reference/glossary/white-box-testing.md b/versioned_docs/version-2.0.0/concepts/reference/glossary/white-box-testing.md index f9e114fa5..86eb20e0c 100644 --- a/versioned_docs/version-2.0.0/concepts/reference/glossary/white-box-testing.md +++ b/versioned_docs/version-2.0.0/concepts/reference/glossary/white-box-testing.md @@ -114,7 +114,7 @@ Firstly, install [Keploy](https://keploy.io/), a testing tool that helps you aut - **Error Analysis and Debugging:** Utilize Keploy’s built-in error analysis tools to identify and resolve issues within your code. Keploy provides detailed insights into errors, helping you quickly pinpoint and fix problems in the internal logic of your application. -- C**ontinuous Integration and Testing:** Integrate Keploy with your CI pipeline to automate white box testing. This ensures that internal testing is part of your regular development workflow, helping maintain high code quality and quickly catch regressions or new issues. +- **Continuous Integration and Testing:** Integrate Keploy with your CI pipeline to automate white box testing. This ensures that internal testing is part of your regular development workflow, helping maintain high code quality and quickly catch regressions or new issues. ## Conclusion diff --git a/versioned_docs/version-2.0.0/dependencies/http.md b/versioned_docs/version-2.0.0/dependencies/http.md index 64c3fe6a1..92b216036 100644 --- a/versioned_docs/version-2.0.0/dependencies/http.md +++ b/versioned_docs/version-2.0.0/dependencies/http.md @@ -39,7 +39,7 @@ The http parser is basically divided into two sections, `encode` and `decode`, t So in the record mode, the encode function is provided with the initial request, which is written to the destination connection and checked if the request is chunked, if it is then parser keeps reading the request from the client connection and write it to the destination connection. -Next, if the request contains the expect header or not. The expect header is used by a client when sending very large requests. So it is basically used to ask the server if it is ready to accept such a large req or not, if it is, then the server responds with a `"100-continue"` response. This is what we also check by writing the request to the destination connection and reading the respnse from it. We start reading the response and we handle chunking in that case as well. Then finally, keploy parse the request and response to store it in mocks. +Next, if the request contains the expect header or not. The expect header is used by a client when sending very large requests. So it is basically used to ask the server if it is ready to accept such a large req or not, if it is, then the server responds with a `"100-continue"` response. This is what we also check by writing the request to the destination connection and reading the response from it. We start reading the response and we handle chunking in that case as well. Then finally, keploy parse the request and response to store it in mocks. Hope this helps you out, if you still have any questions, reach out to us . diff --git a/versioned_docs/version-2.0.0/hacktoberfest/contribution-guide.md b/versioned_docs/version-2.0.0/hacktoberfest/contribution-guide.md index c6fff7212..f8bcc1af2 100644 --- a/versioned_docs/version-2.0.0/hacktoberfest/contribution-guide.md +++ b/versioned_docs/version-2.0.0/hacktoberfest/contribution-guide.md @@ -20,7 +20,7 @@ If you’ve ever wanted to contribute to open source, now is your chance! You ca Anyone around the globe who desires to help drive the growth of open source and make positive contributions to an ever-growing community. All backgrounds and skill levels are encouraged to participate. -#### Code Contributribution to Keploy Projects includes: +#### Code Contribution to Keploy Projects includes: - 🛠️ Bug fixes - 👉 New features diff --git a/versioned_docs/version-2.0.0/keploy-cloud/deduplication.md b/versioned_docs/version-2.0.0/keploy-cloud/deduplication.md index 0b1d00e2d..88422b5d6 100644 --- a/versioned_docs/version-2.0.0/keploy-cloud/deduplication.md +++ b/versioned_docs/version-2.0.0/keploy-cloud/deduplication.md @@ -42,7 +42,7 @@ Install the `keploy/sdk` and `nyc` package : - npm i @keploy/sdk nyc@15.0.0 ``` -Add the the following on top of your main application js file (index.js/server.js/app.js/main.js) : - +Add the following on top of your main application js file (index.js/server.js/app.js/main.js) : - ```bash const kmiddleware = require('@keploy/sdk/dist/v2/dedup/middleware.js') diff --git a/versioned_docs/version-2.0.0/keploy-cloud/mock-registry.md b/versioned_docs/version-2.0.0/keploy-cloud/mock-registry.md index 6cf755de2..f27de148d 100644 --- a/versioned_docs/version-2.0.0/keploy-cloud/mock-registry.md +++ b/versioned_docs/version-2.0.0/keploy-cloud/mock-registry.md @@ -15,7 +15,7 @@ keywords: Mock Registry uploads mock files to cloud storage, keeping the application's repository lightweight and manageable. -When dealing with large mock files during tests, committing them to git repositories can be cumbersome. **Uploading such mocks to cloud storage** instead helps maintain a clean and performant repository, reducing complexity. +When dealing with large mock files during tests, committing them to git repositories can be cumbersome. **Uploading such mocks to cloud storage** instead helps maintain a clean and performat repository, reducing complexity. ## Usage 🛠️ diff --git a/versioned_docs/version-2.0.0/keploy-cloud/testgeneration.md b/versioned_docs/version-2.0.0/keploy-cloud/testgeneration.md index 892d42c48..56be74993 100644 --- a/versioned_docs/version-2.0.0/keploy-cloud/testgeneration.md +++ b/versioned_docs/version-2.0.0/keploy-cloud/testgeneration.md @@ -416,7 +416,7 @@ docker-compose up -d postgres ## Generate test-cases -Now that we have our schema file, we need to create create jar file since we are using java sample-application :- +Now that we have our schema file, we need to create jar file since we are using java sample-application :- ```sh mvn clean install -DskipTests diff --git a/versioned_docs/version-2.0.0/keploy-cloud/time-freezing.md b/versioned_docs/version-2.0.0/keploy-cloud/time-freezing.md index 5297af402..ab6d9fa1f 100644 --- a/versioned_docs/version-2.0.0/keploy-cloud/time-freezing.md +++ b/versioned_docs/version-2.0.0/keploy-cloud/time-freezing.md @@ -46,7 +46,7 @@ For Docker-based applications, you'll need to make a few adjustments to your Doc uname -a ``` -2. Download the the appropriate time freeze agent for your architecture & set the `LD_PRELOAD` Environment Variable in your Dockerfile +2. Download the appropriate time freeze agent for your architecture & set the `LD_PRELOAD` Environment Variable in your Dockerfile ### For Golang(Go) Applications - diff --git a/versioned_docs/version-2.0.0/quickstart/node-express-mongoose.md b/versioned_docs/version-2.0.0/quickstart/node-express-mongoose.md index ea37a2fad..c2d433f2c 100644 --- a/versioned_docs/version-2.0.0/quickstart/node-express-mongoose.md +++ b/versioned_docs/version-2.0.0/quickstart/node-express-mongoose.md @@ -42,7 +42,7 @@ Depending on your OS, choose your adventure: There are 2 ways you can run this sample application. - [Using Docker compose : running application as well as MongoDb on Docker container](#using-docker-compose-) -- [Using Docker container for mongoDb and running application locally](#running-app-locally-on-linuxwsl-) +- [Using Docker container for mongodb and running application locally](#running-app-locally-on-linuxwsl-) ## Using Docker Compose 🐳 diff --git a/versioned_docs/version-2.0.0/quickstart/sample-rust-crud-mongo.md b/versioned_docs/version-2.0.0/quickstart/sample-rust-crud-mongo.md index bd4dc6fff..67b8b05bb 100644 --- a/versioned_docs/version-2.0.0/quickstart/sample-rust-crud-mongo.md +++ b/versioned_docs/version-2.0.0/quickstart/sample-rust-crud-mongo.md @@ -95,7 +95,7 @@ Afterward, create a GET all request, and you will get the following output in yo ![Test-case](/img/rust-mongo-rest-postman-get-all-success.png?raw=true) -We peformed two requests, one to create a note and one to get all notes. These requests are captured as testcases by Keploy. +We performed two requests, one to create a note and one to get all notes. These requests are captured as testcases by Keploy. ### Run the testcases diff --git a/versioned_docs/version-2.0.0/quickstart/samples-echo.md b/versioned_docs/version-2.0.0/quickstart/samples-echo.md index c97ca527d..9f0f127c3 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-echo.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-echo.md @@ -176,7 +176,7 @@ sudo -E PATH=$PATH keploy record -c "./echo-psql-url-shortener" #### Generate testcases -To genereate testcases we just need to make some API calls. You can use Postman, Hoppscotch, or simply curl +To generate testcases we just need to make some API calls. You can use Postman, Hoppscotch, or simply curl ```bash curl --request POST \ diff --git a/versioned_docs/version-2.0.0/quickstart/samples-go-sse-svelte.md b/versioned_docs/version-2.0.0/quickstart/samples-go-sse-svelte.md index 67090c931..3b4d619f0 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-go-sse-svelte.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-go-sse-svelte.md @@ -59,7 +59,7 @@ Now, we will create the binary of our application:- go build -cover ``` -Once we have our applicaiton binary ready, we will start the application with keploy to start capturing the testcases. +Once we have our application binary ready, we will start the application with keploy to start capturing the testcases. ## Capture the test cases diff --git a/versioned_docs/version-2.0.0/quickstart/samples-node-mongo.md b/versioned_docs/version-2.0.0/quickstart/samples-node-mongo.md index e8305ed95..c365d7471 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-node-mongo.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-node-mongo.md @@ -21,7 +21,7 @@ keyword: - Auto Testcase generation --- -## Intoduction 📌 +## Introduction 📌 A sample **_CRUD_** application to see how Keploy integrates effortlessly with **_Express.js_** and **_MongoDB_**. Get ready to see the power of Keploy 🔅🔅. diff --git a/versioned_docs/version-2.0.0/running-keploy/unit-test-generator.md b/versioned_docs/version-2.0.0/running-keploy/unit-test-generator.md index 97bcc77ac..0838b601e 100644 --- a/versioned_docs/version-2.0.0/running-keploy/unit-test-generator.md +++ b/versioned_docs/version-2.0.0/running-keploy/unit-test-generator.md @@ -49,7 +49,7 @@ export API_KEY=xxxx ## Running with Javascript/TypeScript applications -For the we need to make sure that the coverage report is in coberuta format, so to make sure let's modify our `package.json` by adding : +For the we need to make sure that the coverage report is in cobertura format, so to make sure let's modify our `package.json` by adding : ```json "jest": { @@ -121,7 +121,7 @@ go install github.com/AlekSi/gocov-xml@v1.1.0 ### Generating Unit Tests -With the above dependecies installed, we can now generate tests for our application by the following dommand : - +With the above dependencies installed, we can now generate tests for our application by the following command : - ```bash keploy gen --source-file-path="o" \ diff --git a/versioned_docs/version-2.0.0/server/sdk-installation/python.md b/versioned_docs/version-2.0.0/server/sdk-installation/python.md index 71a508d4f..e2b4eac9e 100644 --- a/versioned_docs/version-2.0.0/server/sdk-installation/python.md +++ b/versioned_docs/version-2.0.0/server/sdk-installation/python.md @@ -32,7 +32,7 @@ To get the coverage data for your unit tests: coverage run --data-file=.coverage.unit test_program.py ``` -Here, test_program.py is the unit test program you want to run, and --data-file is set to .coverage.unit becuase, by default, raw coverage data would be written to .coverage which is where coverage data for keploy tests is present, so to avoid overwritting we pass a new file through data-file flag. +Here, test_program.py is the unit test program you want to run, and --data-file is set to .coverage.unit because, by default, raw coverage data would be written to .coverage which is where coverage data for keploy tests is present, so to avoid overwritting we pass a new file through data-file flag. > Note: If you face any problems with running the coverage library, you can refer to the documentation for the same [here](https://coverage.readthedocs.io/en/7.4.2/cmd.html#execution-coverage-run) diff --git a/versioned_sidebars/version-1.0.0-sidebars.json b/versioned_sidebars/version-1.0.0-sidebars.json index 4f32fd178..2e2d72989 100644 --- a/versioned_sidebars/version-1.0.0-sidebars.json +++ b/versioned_sidebars/version-1.0.0-sidebars.json @@ -15,10 +15,7 @@ "label": "Installation", "collapsible": true, "collapsed": false, - "items": [ - "server/server-installation", - "server/sdk-installation" - ] + "items": ["server/server-installation", "server/sdk-installation"] }, { "type": "category", @@ -140,9 +137,7 @@ "type": "doc", "id": "java/quickstart/index" }, - "items": [ - "java/quickstart/spring-sql" - ] + "items": ["java/quickstart/spring-sql"] }, { "type": "link", diff --git a/versions.json b/versions.json index 76b961b2b..04c9f68a8 100644 --- a/versions.json +++ b/versions.json @@ -1,4 +1 @@ -[ - "2.0.0", - "1.0.0" -] \ No newline at end of file +["2.0.0", "1.0.0"] From dd7266e0c9df71c4f6648bbf3795d370943e3d73 Mon Sep 17 00:00:00 2001 From: Pratik Mahalle Date: Wed, 21 May 2025 20:29:26 +0530 Subject: [PATCH 2/6] fix: style guide violations and spelling errors --- .github/CLA.md | 6 +- .github/styles/accept.txt | 89 +++++++++++++++++++ .github/workflows/prettify_code.yml | 9 +- .vale.ini | 26 +++--- .../keploy-explained/testing-guide.md | 2 +- .../keploy-explained/why-keploy.md | 2 +- .../version-2.0.0/quickstart/samples-echo.md | 8 +- 7 files changed, 115 insertions(+), 27 deletions(-) create mode 100644 .github/styles/accept.txt diff --git a/.github/CLA.md b/.github/CLA.md index 6302b5d34..f03e8f65e 100644 --- a/.github/CLA.md +++ b/.github/CLA.md @@ -12,14 +12,14 @@ You accept and agree to the following terms and conditions for Your present and 2. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works. -3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution(s) alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. +3. Grant of Patent License. Subject to the terms and conditions of this Agreement, You grant to "Keploy" and to recipients of software distributed by "Keploy" a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contribution alone or by combination of Your Contribution with the Work to which such Contribution was submitted. -4. You represent that you are legally entitled to grant the above license. If your employer(s) has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to "Keploy", or that your employer has executed a separate Contributor License Agreement with "Keploy". +4. You represent that you are legally entitled to grant the above license. If your employer has rights to intellectual property that you create that includes your Contributions, you represent that you have received permission to make Contributions on behalf of that employer, that your employer has waived such rights for your Contributions to "Keploy", or that your employer has executed a separate Contributor License Agreement with "Keploy". 5. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which you are personally aware and which are associated with any part of Your Contributions. 6. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. -7. Should You wish to submit work that is not Your original creation, You may submit it to "Keploy" separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]". +7. Should You wish to submit work that is not Your original creation, You may submit it to "Keploy" separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which you are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]." 8. You agree to notify "Keploy" of any facts or circumstances of which you become aware that would make these representations inaccurate in any respect. \ No newline at end of file diff --git a/.github/styles/accept.txt b/.github/styles/accept.txt new file mode 100644 index 000000000..6568677f6 --- /dev/null +++ b/.github/styles/accept.txt @@ -0,0 +1,89 @@ +mongodb +linux +env +homebrew +Zsh +zsh +globbing +sudoers +repo +args +Mux +KTests +KTest +traceroute +oss +moc +cli +Prisma +VSCode +yaml +Sanic +sanic +shorteners +mongoDb +Wohoo +essentailly +traceroute +hardcoded +Reusability +Behat +RSpec +Chai +testng +Challegnes +Whitebox +LLM's +PHPUnit +shopify +invaliduser +performat +param +js +dedup +Autogenerate +wiremessage +isMaster +http +sublicense +vale_styles +doxing +petclinic +walkthrough +mins +anonymized +testfile +Surgefire +eg +GMaps +classpath +Intellij +servlets +myApp +denoise +Gitpod +uncommenting +Env +resonse +ide +inplements +sql +razorpay +subcommand +javascript +nyc +xml +json +Sudo +catelog +litellm +overwritting +renametest +subequent +testset +Passthrough +Karaf +karaf +octokit +ui +gqlgen diff --git a/.github/workflows/prettify_code.yml b/.github/workflows/prettify_code.yml index 47cb584d7..cc879f1c7 100644 --- a/.github/workflows/prettify_code.yml +++ b/.github/workflows/prettify_code.yml @@ -11,11 +11,13 @@ jobs: runs-on: ubuntu-latest steps: - - name: Checkout - uses: actions/checkout@v3 + - name: Checkout PR branch + uses: actions/checkout@v4 with: ref: ${{ github.head_ref }} + repository: ${{ github.event.pull_request.head.repo.full_name }} fetch-depth: 0 + token: ${{ secrets.GITHUB_TOKEN }} - name: Prettify code uses: creyD/prettier_action@v4.3 @@ -23,5 +25,4 @@ jobs: # This part is also where you can pass other options, for example: prettier_version: 2.8.8 prettier_options: --write **/*.{js,md} - same_commit: true - \ No newline at end of file + same_commit: true \ No newline at end of file diff --git a/.vale.ini b/.vale.ini index 3bb7088aa..904a4b415 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,25 +1,23 @@ -# vale.ini - StylesPath = vale_styles # Update this path to where your styles are stored. -MinAlertLevel = error # Set the minimum alert level to display (suggestion, warning, or error). +MinAlertLevel = error Vocab = Base [*.md] -# Enable Markdown-specific styles. BasedOnStyles = Vale, Google -# Customize specific rules based on your needs. List.Capitalization = YES -# Override some rules: Vale.Spelling = YES -Google.PassiveVoice = NO # Disable passive voice rule if unnecessary -Google.We = NO # Disable first-person plural flagging -Google.Will = NO # Allow "will" usage -Google.Exclamation = NO # Allow exclamation points -Google.Ellipses = NO # Allow ellipses in text -Google.Latin = NO # Allow "e.g." and "i.e." instead of "for example" +# Point Vale.Spelling to your Accept.txt custom word list +# This assumes your spelling config uses accept.txt for whitelisted words +# See: https://vale.sh/docs/topics/styles/#accept-txt +Spelling.Accept = Accept.txt -# Allow specific terms: -Vale.Terms=NO +Google.PassiveVoice = NO +Google.We = NO +Google.Will = NO +Google.Exclamation = NO +Google.Ellipses = NO +Google.Latin = NO +Vale.Terms = NO \ No newline at end of file diff --git a/versioned_docs/version-2.0.0/keploy-explained/testing-guide.md b/versioned_docs/version-2.0.0/keploy-explained/testing-guide.md index 8eb6d488f..0e951ad76 100644 --- a/versioned_docs/version-2.0.0/keploy-explained/testing-guide.md +++ b/versioned_docs/version-2.0.0/keploy-explained/testing-guide.md @@ -69,7 +69,7 @@ These two scenarios are designed to ensure the detection of changes, including a ### Recording and testing of tests and mocks via test-bench -Right now, in this guide i am only showing the first scenario, to run the second scenario you just need to replace the binaries as mentioned in the **4th** step. +Right now, in this guide i am only showing the first scenario, to run the second scenario you just need to replace the binaries as mentioned in the **fourth** step. #### Recording Phase 🎥 diff --git a/versioned_docs/version-2.0.0/keploy-explained/why-keploy.md b/versioned_docs/version-2.0.0/keploy-explained/why-keploy.md index df995a6c0..a5194c404 100644 --- a/versioned_docs/version-2.0.0/keploy-explained/why-keploy.md +++ b/versioned_docs/version-2.0.0/keploy-explained/why-keploy.md @@ -28,7 +28,7 @@ tags: ⭐ If you're excited about what's coming, show some love by [starring Keploy on GitHub](https://github.com/keploy/keploy) -🤙 We're happy to hear from you in-case you want to deep-dive. [Schedule a demo](https://calendar.app.google/3mHeyaoKg3A2qkqF6) – because the best tests are yet to come! 🚀🎉 +🤙 We're happy to hear from you in-case you want to deep-dive. [Schedule a demo](https://calendar.app.google/3mHeyaoKg3A2qkqF6)—because the best tests are yet to come! 🚀🎉 import GetSupport from '../concepts/support.md' diff --git a/versioned_docs/version-2.0.0/quickstart/samples-echo.md b/versioned_docs/version-2.0.0/quickstart/samples-echo.md index 9f0f127c3..285bcb239 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-echo.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-echo.md @@ -127,12 +127,12 @@ Want to see if everything works as expected? Now that we have our testcase captured, we will add `ts` to noise field in `test-*.yaml` files. -**1. On line 32 we will add "`- body.ts`" under the "`header.data`".** +**1. On line 32 we will add "`- body.ts`." under the "`header.data`."** Now let's run the test mode (in the echo-sql directory, not the Keploy directory). ```shell -keploy test -c "docker run -p 8082:8082 --name echoSqlApp --network keploy-network echo-app:1.0" --delay 10 +keploy test -c "docker run -p 8082:8082 --name echoSqlApp --network keploy-network echo-app:1.0" --delay 10\u00A0s ``` output should look like @@ -147,7 +147,7 @@ Congrats on the journey so far! You've seen Keploy's power, flexed your coding m Happy coding! ✨👩‍💻👨‍💻✨ -**\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\_\_\_\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*** +**\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\_\_\_\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*\*\***\*\*\*** ## Running App Locally on Linux/WSL 🐧 @@ -213,7 +213,7 @@ Now both these API calls were captured as a testcase and should be visible on th Now that we have our testcase captured, run the test file. ```shell -sudo -E PATH=$PATH keploy record -c "./echo-psql-url-shortener" --delay 10 +sudo -E PATH=$PATH keploy record -c "./echo-psql-url-shortener" --delay 10\u00A0s ``` So no need to setup dependencies like mongoDB, web-go locally or write mocks for your testing. From e95cdf38a383883e352fec87f001c098a70c5c19 Mon Sep 17 00:00:00 2001 From: Pratik Mahalle Date: Wed, 21 May 2025 21:03:18 +0530 Subject: [PATCH 3/6] fix: resolve Vale linting issues - Fix spacing between letters in mongo types - Fix ordinal numbers and unit spacing - Fix quote punctuation - Fix em dash spacing Signed-off-by: Pratik Mahalle --- .vale.ini | 2 +- .../version-1.0.0/go/supported-frameworks.md | 8 +++---- .../operation/browser-extension.md | 8 +++---- .../version-1.0.0/typescript/testing.md | 2 +- versioned_docs/version-2.0.0/ci-cd/gitlab.md | 6 ++--- versioned_docs/version-2.0.0/ci-cd/jenkins.md | 4 ++-- .../operation/browser-extension.md | 14 ++++------- .../quickstart/java-spring-postgres.md | 2 +- .../version-2.0.0/quickstart/node-jwt-sql.md | 6 ++--- .../version-2.0.0/quickstart/samples-java.md | 4 ++-- .../running-keploy/cli-commands.md | 24 +++++++++---------- 11 files changed, 38 insertions(+), 42 deletions(-) diff --git a/.vale.ini b/.vale.ini index 904a4b415..47d16d060 100644 --- a/.vale.ini +++ b/.vale.ini @@ -11,7 +11,7 @@ Vale.Spelling = YES # Point Vale.Spelling to your Accept.txt custom word list # This assumes your spelling config uses accept.txt for whitelisted words # See: https://vale.sh/docs/topics/styles/#accept-txt -Spelling.Accept = Accept.txt +Spelling.Accept = .github/styles/accept.txt Google.PassiveVoice = NO Google.We = NO diff --git a/versioned_docs/version-1.0.0/go/supported-frameworks.md b/versioned_docs/version-1.0.0/go/supported-frameworks.md index ecfdee343..267d25810 100644 --- a/versioned_docs/version-1.0.0/go/supported-frameworks.md +++ b/versioned_docs/version-1.0.0/go/supported-frameworks.md @@ -239,8 +239,8 @@ col := kmongo.NewCollection(db.Collection("Demo-Collection")) Following operations are supported: -- FindOne - Err and Decode method of mongo.SingleResult -- Find - Next, TryNext, Err, Close, All and Decode methods of mongo.cursor +- FindOne - Err and Decode method of mongo. SingleResult +- Find - Next, TryNext, Err, Close, All and Decode methods of mongo. cursor - InsertOne - InsertMany - UpdateOne @@ -249,7 +249,7 @@ Following operations are supported: - DeleteMany - CountDocuments - Distinct -- Aggregate - Next, TryNext, Err, Close, All and Decode methods of mongo.cursor +- Aggregate - Next, TryNext, Err, Close, All and Decode methods of mongo. cursor @@ -361,7 +361,7 @@ Here is an example for postgres driver and binary encoded outputs - } ``` -> Its compatible with gORM. To integrate with gORM set DisableAutomaticPing of gorm.Config to true. Also pass request context to methods as params. +> Its compatible with gORM. To integrate with gORM set DisableAutomaticPing of gorm. Config to true. Also pass request context to methods as params. > Example for gORM with GCP-Postgres driver: ```go diff --git a/versioned_docs/version-1.0.0/operation/browser-extension.md b/versioned_docs/version-1.0.0/operation/browser-extension.md index 2a2a5b79e..335a8d44e 100644 --- a/versioned_docs/version-1.0.0/operation/browser-extension.md +++ b/versioned_docs/version-1.0.0/operation/browser-extension.md @@ -55,7 +55,7 @@ The Keploy extension will keep running in the background once keploy server is u ![Project name](https://miro.medium.com/max/750/1*lEwF0okhMyKzaS2a8dPA7Q.png) -**Step-2**: Give a title to your 1st test case +**Step-2**: Give a title to your first test case ![Test case](https://miro.medium.com/max/828/1*u1VNf-nXXvekruNphAIfIQ.png) ![Rename test case](https://miro.medium.com/max/378/1*CL3156yKX4UhklO3l_vH4Q.png) @@ -69,16 +69,16 @@ The Keploy extension will keep running in the background once keploy server is u ![Record](https://miro.medium.com/max/456/1*OJBhp3uWaOnNaOynI_jigw.png) -**Step-5**: Now default browser will open, In our case, it’s the chrome browser. +**Step-5**: Now default browser will open, In our case, it's the chrome browser. **Step-6**: Perform your desired actions and selenium will start recording the positions and actions along with the data present at that place. -**Step-7**: In our case we are doing a google search with the keyword oss. We can see many search results present in the suggestion but we will go with the 1 st option. +**Step-7**: In our case we are doing a google search with the keyword oss. We can see many search results present in the suggestion but we will go with the first option. ![Perform Actions](https://miro.medium.com/max/828/1*9wXASZ3JLur3r_Gk2Q-gug.jpeg) ![Record Actions](https://miro.medium.com/max/828/1*4ur53dlBZ94Y2gbJCZLYJA.jpeg) -**Step-8**: We know that our keploy server is already running in the background and keploy extension is present in the chrome browser. In the background, our keploy server is recording all the data coming from APIs on the front end in mongo DB. Let’s see inside mongo DB using mongo compass. +**Step-8**: We know that our keploy server is already running in the background and keploy extension is present in the chrome browser. In the background, our keploy server is recording all the data coming from APIs on the front end in mongo DB. Let's see inside mongo DB using mongo compass. ![Compass Screenshot](https://miro.medium.com/max/828/1*WYChY6_nwLcmUJw5I-j7Dg.jpeg) diff --git a/versioned_docs/version-1.0.0/typescript/testing.md b/versioned_docs/version-1.0.0/typescript/testing.md index 2e84766f5..ffd751552 100644 --- a/versioned_docs/version-1.0.0/typescript/testing.md +++ b/versioned_docs/version-1.0.0/typescript/testing.md @@ -38,4 +38,4 @@ Note:- Jest is not supported currently!! - For VSCode setup, make sure these extensions are installed: - [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) - - [Eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + - [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) diff --git a/versioned_docs/version-2.0.0/ci-cd/gitlab.md b/versioned_docs/version-2.0.0/ci-cd/gitlab.md index 13501bdad..d2c45c36e 100644 --- a/versioned_docs/version-2.0.0/ci-cd/gitlab.md +++ b/versioned_docs/version-2.0.0/ci-cd/gitlab.md @@ -68,11 +68,11 @@ In your `.gitlab-ci.yml file`, in last step we have `keploy test` command to run Did you notice some weird stuff in the pipeline? Like `kmod`, `linux-headers`, `/sys/kernel/debug`...and thought, _"Wait, am I hacking the kernel or something?"_ 😅 -Don’t worry — these are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app’s behavior. +Don't worry—these are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app's behavior. So we install `kmod`, `linux-headers-generic`, and `bpfcc-tools` to make that tracing possible. -Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs` — it’s like giving Keploy the **backstage pass** it needs to watch your app in action. +Some CI systems don't have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs`—it's like giving Keploy the **backstage pass** it needs to watch your app in action. No black magic. Just some low-level Linux stuff helping your tests run like magic! 🪄✨ @@ -145,7 +145,7 @@ Integrating Keploy with GitLab CI automates the testing process, ensuring that t ### 📦 Need the Full Pipeline? -If you’re thinking, “This pipeline looks cool, but I need the _whole thing_ to integrate with your application!” — well, you're in luck! Check it out [here](https://github.com/keploy/samples-python) and get ready to copy-paste your way to success! ✨🚀 +If you're thinking, "This pipeline looks cool, but I need the _whole thing_ to integrate with your application!"—well, you're in luck! Check it out [here](https://github.com/keploy/samples-python) and get ready to copy-paste your way to success! ✨🚀 Hope this helps you out, if you still have any questions, reach out to us . diff --git a/versioned_docs/version-2.0.0/ci-cd/jenkins.md b/versioned_docs/version-2.0.0/ci-cd/jenkins.md index 50a7c3a35..bdf451424 100644 --- a/versioned_docs/version-2.0.0/ci-cd/jenkins.md +++ b/versioned_docs/version-2.0.0/ci-cd/jenkins.md @@ -108,11 +108,11 @@ pipeline { Did you notice some weird stuff in the pipeline? Like `kmod`, `linux-headers`, `/sys/kernel/debug`...and thought, _"Wait, am I hacking the kernel or something?"_ 😅 -Don’t worry — these are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app’s behavior. +Don't worry—these are just there because **Keploy uses eBPF** (a cool Linux feature) to trace your app's behavior. So we install `kmod`, `linux-headers-generic`, and `bpfcc-tools` to make that tracing possible. -Some CI systems don’t have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs` — it’s like giving Keploy the **backstage pass** it needs to watch your app in action. +Some CI systems don't have `/sys/kernel/debug` and `/sys/kernel/tracing` by default, so we create them and mount `debugfs` and `tracefs`—it's like giving Keploy the **backstage pass** it needs to watch your app in action. No black magic. Just some low-level Linux stuff helping your tests run like magic! 🪄✨ diff --git a/versioned_docs/version-2.0.0/operation/browser-extension.md b/versioned_docs/version-2.0.0/operation/browser-extension.md index a8de065d8..168364ad8 100644 --- a/versioned_docs/version-2.0.0/operation/browser-extension.md +++ b/versioned_docs/version-2.0.0/operation/browser-extension.md @@ -56,7 +56,7 @@ once keploy server is up. ![Project name](https://miro.medium.com/max/750/1*lEwF0okhMyKzaS2a8dPA7Q.png) -**Step-2**: Give a title to your 1st test case +**Step-2**: Give a title to your first test case ![Test case](https://miro.medium.com/max/828/1*u1VNf-nXXvekruNphAIfIQ.png) ![Rename test case](https://miro.medium.com/max/378/1*CL3156yKX4UhklO3l_vH4Q.png) @@ -70,25 +70,21 @@ once keploy server is up. ![Record](https://miro.medium.com/max/456/1*OJBhp3uWaOnNaOynI_jigw.png) -**Step-5**: Now default browser will open, In our case, it’s the chrome browser. +**Step-5**: Now default browser will open, In our case, it's the chrome browser. **Step-6**: Perform your desired actions and selenium will start recording the positions and actions along with the data present at that place. -**Step-7**: In our case we are doing a google search with the keyword oss. We can see many search results present in the -suggestion but we will go with the 1 st option. +**Step-7**: In our case we are doing a google search with the keyword oss. We can see many search results present in the suggestion but we will go with the first option. ![Perform Actions](https://miro.medium.com/max/828/1*9wXASZ3JLur3r_Gk2Q-gug.jpeg) ![Record Actions](https://miro.medium.com/max/828/1*4ur53dlBZ94Y2gbJCZLYJA.jpeg) -**Step-8**: We know that our keploy server is already running in the background and keploy extension is present in the -chrome browser. In the background, our keploy server is recording all the data coming from APIs on the front end in -mongo DB. Let’s see inside mongo DB using mongo compass. +**Step-8**: We know that our keploy server is already running in the background and keploy extension is present in the chrome browser. In the background, our keploy server is recording all the data coming from APIs on the front end in mongo DB. Let's see inside mongo DB using mongo compass. ![Compass Screenshot](https://miro.medium.com/max/828/1*WYChY6_nwLcmUJw5I-j7Dg.jpeg) -**Step-9**: Now we will replay the recorded data in selenium, but this time data will not come from live servers of -google, instead of that data will come from the moc database made by keploy +**Step-9**: Now we will replay the recorded data in selenium, but this time data will not come from live servers of google, instead of that data will come from the moc database made by keploy ![Re-Run with Keploy](https://miro.medium.com/max/828/1*9wXASZ3JLur3r_Gk2Q-gug.jpeg) ![Test Run](https://miro.medium.com/max/828/1*4ur53dlBZ94Y2gbJCZLYJA.jpeg) diff --git a/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md b/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md index 4d4c914f8..4a70e833c 100644 --- a/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md +++ b/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md @@ -146,7 +146,7 @@ Your CLI should look something like this This is a summary of the test cases recorded Sample Keploy Test Summary Java -Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10s to get started, you can change the `delay` accordingly. +Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10 s to get started, you can change the `delay` accordingly. `buildDelay` is the time that it takes for the image to get built. This is useful when you are building the docker image from your docker compose file itself. Hope this helps you out, if you still have any questions, reach out to us . diff --git a/versioned_docs/version-2.0.0/quickstart/node-jwt-sql.md b/versioned_docs/version-2.0.0/quickstart/node-jwt-sql.md index d6c9e58f3..cd6693889 100644 --- a/versioned_docs/version-2.0.0/quickstart/node-jwt-sql.md +++ b/versioned_docs/version-2.0.0/quickstart/node-jwt-sql.md @@ -175,8 +175,8 @@ Our testcases will fail as the token would expire and new Token will generated a Sample Keploy Test Result Node JWT -But for this application, the Token expiration is 10 mins so let's go ahead and test the application within 10mins. Let's add the `Etag` and `accessToken` as the noise in the `test-3.yml` on line 45 under `header.Date`. The file would look like:- -But for this application, the Token expiration is 10 mins so let's go ahead and test the application within 10mins. Let's add the `Etag` and `accessToken` as the noise in the `test-3.yml` on line 45 under `header.Date`. The file would look like:- +But for this application, the Token expiration is 10 mins so let's go ahead and test the application within 10 mins. Let's add the `Etag` and `accessToken` as the noise in the `test-3.yml` on line 45 under `header.Date`. The file would look like:- +But for this application, the Token expiration is 10 mins so let's go ahead and test the application within 10 mins. Let's add the `Etag` and `accessToken` as the noise in the `test-3.yml` on line 45 under `header.Date`. The file would look like:- ``` noise: @@ -319,7 +319,7 @@ Our testcases will fail as the token would expire and new Token will generated a Sample Keploy Test Result Node JWT -But for this application, the Token expiration is 10 mins so let's go ahead and test the application within 10mins. Let's add the `Etag` and `accessToken` as the noise in the `test-3.yml` on line 45 under `header.Date`. The file would look like:- +But for this application, the Token expiration is 10 mins so let's go ahead and test the application within 10 mins. Let's add the `Etag` and `accessToken` as the noise in the `test-3.yml` on line 45 under `header.Date`. The file would look like:- ``` noise: diff --git a/versioned_docs/version-2.0.0/quickstart/samples-java.md b/versioned_docs/version-2.0.0/quickstart/samples-java.md index 4dbdee249..0bad51281 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-java.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-java.md @@ -288,7 +288,7 @@ Your CLI should look something like this This is a summary of the test cases recorded Sample Keploy Test Summary Java -Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10s to get started, you can change the `delay` accordingly. +Here `delay` is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10 s to get started, you can change the `delay` accordingly. `buildDelay` is the time that it takes for the image to get built. This is useful when you are building the docker image from your docker compose file itself. ### 🎉 Wrapping it up @@ -298,7 +298,7 @@ Congrats on the journey so far! You've seen Keploy's power, flexed your coding m ## 🚀 Wanna try Keploy in CI/CD? We got you 😎 -Here’s how to set it up with GitHub Actions: +Here's how to set it up with GitHub Actions: 👉 [Keploy + GitHub CI/CD Guide](https://keploy.io/docs/ci-cd/github) Hope this helps you out, if you still have any questions, reach out to us . diff --git a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md index 836239acd..80e37d2da 100755 --- a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md @@ -47,18 +47,18 @@ keploy record [flags] - `-c, --command string` - Command required to start the user application. ```bash - keploy record --command "node src/app.js" + keploy record --command "node src/app.js." ``` - In the command above, `node src/app.js` is the command which starts the user application. + In the command above, `node src/app.js.` is the command which starts the user application. -- `--config-path string` - Path to the Keploy configuration file. The default is ".". +- `--config-path string` - Path to the Keploy configuration file. The default is "." ```bash - keploy record -c "node src/app.js" --config-path "./config-dir/" + keploy record -c "node src/app.js" --config-path "./config-dir/." ``` - In the above command, `config-dir` is the directory in the CWD where the Keploy configuration file `keploy.yaml` is stored. + In the above command, `config-dir.` is the directory in the CWD where the Keploy configuration file `keploy.yaml` is stored. - `--container-name string` - Name of the docker container in which the user application is running. @@ -131,13 +131,13 @@ keploy test [flags] In the command above, `node src/app.js` is the command which starts the user application. -- `--config-path string` - Path to the Keploy configuration file. The default is ".". +- `--config-path string` - Path to the Keploy configuration file. The default is "." ```bash - keploy test -c "node src/app.js" --config-path "./config-dir/" + keploy test -c "node src/app.js" --config-path "./config-dir/." ``` - In the above command, `config-dir` is the directory in the CWD where the Keploy configuration file `keploy.yaml` is stored. + In the above command, `config-dir.` is the directory in the CWD where the Keploy configuration file `keploy.yaml` is stored. - `--container-name string` - Name of the docker container in which the user application is running. @@ -151,7 +151,7 @@ keploy test [flags] keploy test -c "node src/app.js" --delay 10 ``` -- `--mongo-password string` - Authentication password for mocking MongoDB connection. The default password is "default123". +- `--mongo-password string` - Authentication password for mocking MongoDB connection. The default password is "default123." ```bash keploy test -c "node src/app.js" --mongo-password "my-password" @@ -323,13 +323,13 @@ keploy config [flags] keploy config --generate ``` -- `-p, --path string` - Path to the local directory where the Keploy Configuration File will be stored. The default is ".". +- `-p, --path string` - Path to the local directory where the Keploy Configuration File will be stored. The default is "." ```bash - keploy config --generate --path "./config-dir/" + keploy config --generate --path "./config-dir/." ``` - In the above command, `config-dir` is the directory in the CWD where the Keploy configuration file `keploy.yaml` is to be stored. + In the above command, `config-dir.` is the directory in the CWD where the Keploy configuration file `keploy.yaml` is to be stored. ## [example](#example) From f3cf5f298f019f27b66c19d94511a7ab146d8ada Mon Sep 17 00:00:00 2001 From: Pratik Mahalle Date: Wed, 21 May 2025 21:04:48 +0530 Subject: [PATCH 4/6] fix: resolve Vale linting issues - Fix spacing between letters in mongo types - Fix ordinal numbers and unit spacing - Fix quote punctuation - Fix em dash spacing Signed-off-by: Pratik Mahalle --- .github/styles/accept.txt | 89 ------------------ .vale.ini | 2 +- .../config/vocabularies/Base/accept.txt | 94 ++++++++++++++++++- 3 files changed, 94 insertions(+), 91 deletions(-) delete mode 100644 .github/styles/accept.txt diff --git a/.github/styles/accept.txt b/.github/styles/accept.txt deleted file mode 100644 index 6568677f6..000000000 --- a/.github/styles/accept.txt +++ /dev/null @@ -1,89 +0,0 @@ -mongodb -linux -env -homebrew -Zsh -zsh -globbing -sudoers -repo -args -Mux -KTests -KTest -traceroute -oss -moc -cli -Prisma -VSCode -yaml -Sanic -sanic -shorteners -mongoDb -Wohoo -essentailly -traceroute -hardcoded -Reusability -Behat -RSpec -Chai -testng -Challegnes -Whitebox -LLM's -PHPUnit -shopify -invaliduser -performat -param -js -dedup -Autogenerate -wiremessage -isMaster -http -sublicense -vale_styles -doxing -petclinic -walkthrough -mins -anonymized -testfile -Surgefire -eg -GMaps -classpath -Intellij -servlets -myApp -denoise -Gitpod -uncommenting -Env -resonse -ide -inplements -sql -razorpay -subcommand -javascript -nyc -xml -json -Sudo -catelog -litellm -overwritting -renametest -subequent -testset -Passthrough -Karaf -karaf -octokit -ui -gqlgen diff --git a/.vale.ini b/.vale.ini index 47d16d060..7f8184b59 100644 --- a/.vale.ini +++ b/.vale.ini @@ -11,7 +11,7 @@ Vale.Spelling = YES # Point Vale.Spelling to your Accept.txt custom word list # This assumes your spelling config uses accept.txt for whitelisted words # See: https://vale.sh/docs/topics/styles/#accept-txt -Spelling.Accept = .github/styles/accept.txt +Spelling.Accept = config/vocabularies/Base/accept.txt Google.PassiveVoice = NO Google.We = NO diff --git a/vale_styles/config/vocabularies/Base/accept.txt b/vale_styles/config/vocabularies/Base/accept.txt index a2361fb0a..a25107fe9 100644 --- a/vale_styles/config/vocabularies/Base/accept.txt +++ b/vale_styles/config/vocabularies/Base/accept.txt @@ -65,4 +65,96 @@ templatize wiremessages middleware distros -url \ No newline at end of file +url +mongodb +linux +env +homebrew +Zsh +zsh +globbing +sudoers +repo +args +Mux +KTests +KTest +traceroute +oss +moc +cli +Prisma +VSCode +yaml +Sanic +sanic +shorteners +mongoDb +Wohoo +essentailly +traceroute +hardcoded +Reusability +Behat +RSpec +Chai +testng +Challegnes +Whitebox +LLM's +PHPUnit +shopify +invaliduser +performat +param +js +dedup +Autogenerate +wiremessage +isMaster +http +sublicense +vale_styles +doxing +petclinic +walkthrough +mins +anonymized +testfile +Surgefire +eg +GMaps +classpath +Intellij +servlets +myApp +denoise +Gitpod +uncommenting +Env +resonse +ide +inplements +sql +razorpay +subcommand +javascript +nyc +xml +json +Sudo +catelog +litellm +overwritting +renametest +subequent +testset +Passthrough +Karaf +karaf +octokit +ui +gqlgen +ESLint +llm +gorm From aa6c4830c6c86059831054d1696ab48c1bb52190 Mon Sep 17 00:00:00 2001 From: Pratik Mahalle Date: Wed, 21 May 2025 21:06:20 +0530 Subject: [PATCH 5/6] Update the typo error Signed-off-by: Pratik Mahalle --- versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md b/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md index 4a70e833c..3985cfc91 100644 --- a/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md +++ b/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md @@ -151,6 +151,6 @@ Here `delay` is the time it takes for your application to get started, after whi Hope this helps you out, if you still have any questions, reach out to us . -import GetSupport from '../concepts/support.md' +import GetSupport fom '../concepts/support.md' From bd8fdc16e9844d9143cb28fac8c83437f488813b Mon Sep 17 00:00:00 2001 From: Pratik Mahalle Date: Wed, 21 May 2025 21:07:09 +0530 Subject: [PATCH 6/6] Update the typos error Signed-off-by: Pratik Mahalle --- versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md b/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md index 3985cfc91..4a70e833c 100644 --- a/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md +++ b/versioned_docs/version-2.0.0/quickstart/java-spring-postgres.md @@ -151,6 +151,6 @@ Here `delay` is the time it takes for your application to get started, after whi Hope this helps you out, if you still have any questions, reach out to us . -import GetSupport fom '../concepts/support.md' +import GetSupport from '../concepts/support.md'