refactor: split out fixtures, test cleanup #542
Conversation
... so we can reuse it for Changelog! 🚀 No functional changes were made, docs tests should still pass.
kanadgupta
added
refactor
| @@ -8,12 +8,12 @@ const pushDoc = require('../../lib/pushDoc'); | |||
| module.exports = class SingleDocCommand { | |||
| constructor() { | |||
| this.command = 'docs:single'; | |||
| this.usage = 'docs:single <filepath> [options]'; | |||
| this.usage = 'docs:single <file> [options]'; | |||
There was a problem hiding this comment.
Doesn't <file> need to match the arg that we're going to be using (filePath in this case)?
There was a problem hiding this comment.
Nope, this is just the string used for the usage example
There was a problem hiding this comment.
It's been so long since I've looked at this part of the code but how does it know to give you the first arg as filePath?
There was a problem hiding this comment.
I swear I thought it was parsing the usage string to determine if things were required or not
There was a problem hiding this comment.
this guy:
Lines 28 to 32 in aaad56d
There was a problem hiding this comment.
Ah there it is. Ignore me today!
| @@ -62,7 +62,7 @@ module.exports = class SingleDocCommand { | |||
|
|
|||
| debug(`selectedVersion: ${selectedVersion}`); | |||
|
|
|||
| const createdDoc = await pushDoc(key, selectedVersion, dryRun, filepath); | |||
| const createdDoc = await pushDoc(key, selectedVersion, dryRun, filePath, this.category); | |||
There was a problem hiding this comment.
Where's this.category being set?
There was a problem hiding this comment.
We pass that into the pushDoc function so we can use it for dynamic routing:
Line 42 in aaad56d
The idea is we can use a single handler for docs, changelogs, and custompages routes
There was a problem hiding this comment.
OH right, this.category is the category that it shows up in the help screen.
There was a problem hiding this comment.
lol misread your question so my response didn't actually answer your question but yes, it's for the categories in the help screen
🧰 Changes
Just some refactoring as part of the upcoming Changelog + Custom Pages functionality.
pushDocfunction to support more routes and check for generic 404s as opposed toDOC_NOTFOUNDerrorsfilePathinstead offilepath)docscommand into its own folder🧬 QA & Testing
Do tests pass?