Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

*NOT READY* Refactor #72

Closed
wants to merge 2 commits into from
Closed

Conversation

mrjoelkemp
Copy link
Contributor

Just an early PR to get a bird's eye view of the work in progress and establish some transparency.

Main efforts in this PR:

  • Simplify key parts of the codebase to increase maintainability
  • Isolate functionality into modules
  • Deprecate the use of the -rr option and have -r absorb respecting the directory structure if the input is a directory
    • If the input is a file, then the markdown will be dumped into the root of the output directory (the old behavior of -r)
  • Support the output being a markdown file: jsdox myFile.js -o myOutput.md

Fixes #49
Fixes #56

"validateLineBreaks": "LF"
"validateLineBreaks": "LF",
"requireSpaceAfterLineComment": true,
"safeContextKeyword": "self"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't this too restrictive? what happens when you have multiple nesting levels and you need access to more than one context? Or does it not complain is you copy self to self2 for example?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would complain on self2. On one hand, you can use .bind(this) to avoid the need for self. On the other hand, this prevents deeply nested code which should be cleaner.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bind won't help accessing the variables in the closures. If this ever becomes a problem, we'll remove, or add more names safeContextKeyword can take an array.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1
On Sep 23, 2014 6:02 PM, "Pascal" [email protected] wrote:

In .jscsrc:

@@ -68,5 +68,7 @@
"requireDotNotation": true,
"disallowYodaConditions": true,
"disallowNewlineBeforeBlockStatements": true,

  • "validateLineBreaks": "LF"
  • "validateLineBreaks": "LF",
  • "requireSpaceAfterLineComment": true,
  • "safeContextKeyword": "self"

bind won't help accessing the variables in the closures. If this ever
becomes a problem, we'll remove, or add more names safeContextKeyword can
take an array.


Reply to this email directly or view it on GitHub
https://github.com/sutoiku/jsdox/pull/72/files#r17942596.

@mrjoelkemp mrjoelkemp closed this Jun 29, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

specify input file + output file Change api signature
2 participants