feat(docs): adds ability to delete docs from ReadMe if they're no longer in local folder #581

shaiarmis · 2022-08-24T13:24:09Z

🧰 Changes

The rdme docs command syncs the documents between a local folder and a ReadMe project.
It works really well for new file in the folder, or for editing existing ones, but it does't work for files that were deleted and are no longer needed.
With the new --deleteMissing option (off by default) this is now possible.

🧬 QA & Testing

Sync some files from a folder with your project
Delete one of the files from the folder
Sync again (with --deleteMissing)
The file should be delete from ReadMe

…an only available spec file without any prompts

…files available

This reverts commit 95a8148.

…Me documents that don't exist on the local folder

shaiarmis · 2022-08-24T13:25:53Z

src/lib/fetch.ts

@@ -9,6 +9,8 @@ import APIError from './apiError';
 import isGHA from './isGitHub';
 import { debug } from './logger';

+const SUCCESS_NO_CONTENT = 204;


The DELETE /api/v1/docs/{slug} endpoint returns 204 with an empty body if the deletion was successful.

erunion

one minor comment but overall this seems good to me

src/lib/fetch.ts

src/lib/getDocs.ts

src/lib/deleteDoc.ts

src/cmds/docs/index.ts

src/lib/getSlug.ts

kanadgupta · 2022-08-24T22:32:50Z

src/lib/getDocs.ts

+    .then(Promise.all.bind(Promise))
+    .then(args => [].concat(...args));


These two lines are difficult to follow, any way they can be simplified?

Done (I think ;) )

src/cmds/docs/index.ts

src/lib/getDocs.ts

__tests__/cmds/docs/index.test.ts

…eleted

…add-delete-missing-option

README.md

erunion

Thanks so much for adding this. LGTM but letting @kanadgupta have final sign off before it's merged.

shaiarmis · 2022-08-30T17:01:11Z

Thanks so much for adding this. LGTM but letting @kanadgupta have final sign off before it's merged.

With pleasure, that's what OpenSource is all about :)

Is there an expected timeline for the last two changes to be published to NPM?

kanadgupta · 2022-08-30T17:34:49Z

Is there an expected timeline for the last two changes to be published to NPM?

We're prepping for a big v8 release, so it won't be for at least another week or two!

shaiarmis · 2022-08-31T07:08:43Z

Is there an expected timeline for the last two changes to be published to NPM?

We're prepping for a big v8 release, so it won't be for at least another week or two!

Week or two is great :)

kanadgupta

A few small comments below but this is looking good! Thanks @shaiarmis 🙂

__tests__/cmds/docs/index.test.ts

src/lib/deleteDoc.ts

README.md

src/lib/prompts.ts

kanadgupta

Thanks for your patience and work on this @shaiarmis! LGTM 🥳

shaiarmis and others added 13 commits August 23, 2022 10:55

feat(openapi): Add updateSingleSpec option to automatically update …

0873fef

…an only available spec file without any prompts

feat(docs): Updated docs

8d44028

Fix eslint errors

f0da91b

Throw error if using --updateSingleSpec when there are multiple spec …

60e1513

…files available

Show a warning when passing both --updateSingleSpec and --id

8e83532

Update tests snapshot

e1e9f92

docs: copy edits, rename flag to --update

b68e0ed

fix: add logic for if create and update flags passed together

bba9448

ci: attempt to skip failing step if API key isn't present

95a8148

Revert "ci: attempt to skip failing step if API key isn't present"

8ca1596

This reverts commit 95a8148.

Merge branch 'main' into pr/579

1a2658b

Merge branch 'readmeio:main' into main

0f9730f

Add --deleteMissing option to rdme docs command to delete from Read…

3f76bca

…Me documents that don't exist on the local folder

shaiarmis commented Aug 24, 2022

View reviewed changes

Take into account only "guide" categories

0292a09

kanadgupta added enhancement New feature or request command:docs Issues pertaining to the `docs`, `changelogs`, or `custompages` commands labels Aug 24, 2022

erunion requested changes Aug 24, 2022

View reviewed changes

src/lib/fetch.ts Show resolved Hide resolved

erunion requested a review from kanadgupta August 24, 2022 22:17

chore: markdown formatting

daa9c17

kanadgupta requested changes Aug 24, 2022

View reviewed changes

shaiarmis added 9 commits August 25, 2022 08:53

Add warning about what the new option does

276f6f0

Improved typing of functions

082d4c1

Move "if" to a more proper location

2b31260

Refactor "getSlug" to "readDoc" and reuse code

8b1ba91

Removed unused code

e174386

Simplify code

4145c99

Refactored tests to use a folder with a document that should not be d…

e5c6eac

…eleted

Merge remote-tracking branch 'origin/add-delete-missing-option' into …

27d3fa0

…add-delete-missing-option

Added a confirmation prompt when folder is empty

637a7af

kanadgupta self-requested a review August 29, 2022 20:14

shaiarmis requested review from erunion and removed request for kanadgupta August 30, 2022 07:07

erunion requested changes Aug 30, 2022

View reviewed changes

README.md Outdated Show resolved Hide resolved

Rename --deleteMissing to --cleanup

771ccf2

erunion approved these changes Aug 30, 2022

View reviewed changes

shaiarmis requested a review from kanadgupta September 5, 2022 07:14

Merge branch 'main' into add-delete-missing-option

d679349

kanadgupta requested changes Sep 7, 2022

View reviewed changes

__tests__/cmds/docs/index.test.ts Outdated Show resolved Hide resolved

__tests__/cmds/docs/index.test.ts Show resolved Hide resolved

src/lib/deleteDoc.ts Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

src/lib/prompts.ts Outdated Show resolved Hide resolved

shaiarmis and others added 4 commits September 8, 2022 09:16

CR

bd51962

Merge branch 'main' into add-delete-missing-option

ac79f09

Undo accidental commit

5af81ee

Update index.ts

46e2323

kanadgupta changed the title ~~Add the ability to delete documents from ReadMe if they're no longer in the folder~~ feat(docs): adds ability to delete docs from ReadMe if they're no longer in local folder Sep 12, 2022

kanadgupta approved these changes Sep 12, 2022

View reviewed changes

kanadgupta merged commit 939bce6 into readmeio:main Sep 12, 2022

shaiarmis deleted the add-delete-missing-option branch September 13, 2022 08:45

r0hack mentioned this pull request Dec 26, 2022

[Snyk] Security upgrade config from 3.2.4 to 3.3.1 r0hack/rdme#5

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(docs): adds ability to delete docs from ReadMe if they're no longer in local folder #581

feat(docs): adds ability to delete docs from ReadMe if they're no longer in local folder #581

shaiarmis commented Aug 24, 2022

shaiarmis Aug 24, 2022

erunion left a comment

kanadgupta Aug 24, 2022

shaiarmis Aug 25, 2022

erunion left a comment

shaiarmis commented Aug 30, 2022

kanadgupta commented Aug 30, 2022

shaiarmis commented Aug 31, 2022

kanadgupta left a comment

kanadgupta left a comment

		.then(Promise.all.bind(Promise))
		.then(args => [].concat(...args));

feat(docs): adds ability to delete docs from ReadMe if they're no longer in local folder #581

feat(docs): adds ability to delete docs from ReadMe if they're no longer in local folder #581

Conversation

shaiarmis commented Aug 24, 2022

🧰 Changes

🧬 QA & Testing

shaiarmis Aug 24, 2022

Choose a reason for hiding this comment

erunion left a comment

Choose a reason for hiding this comment

kanadgupta Aug 24, 2022

Choose a reason for hiding this comment

shaiarmis Aug 25, 2022

Choose a reason for hiding this comment

erunion left a comment

Choose a reason for hiding this comment

shaiarmis commented Aug 30, 2022

kanadgupta commented Aug 30, 2022

shaiarmis commented Aug 31, 2022

kanadgupta left a comment

Choose a reason for hiding this comment

kanadgupta left a comment

Choose a reason for hiding this comment