From d5877c1217d4d5ee7445db21ed34c805559b5fa4 Mon Sep 17 00:00:00 2001 From: Jeff Williams Date: Sun, 23 Dec 2012 14:09:37 -0800 Subject: [PATCH] move rhino_modules/ to lib/ --- README.md | 2 +- jsdoc | 4 +- jsdoc.cmd | 4 +- jsdoc.js | 49 +++++++++---------- {rhino_modules => lib}/jsdoc/augment.js | 0 {rhino_modules => lib}/jsdoc/borrow.js | 0 {rhino_modules => lib}/jsdoc/config.js | 0 {rhino_modules => lib}/jsdoc/doclet.js | 0 {rhino_modules => lib}/jsdoc/name.js | 0 .../jsdoc/opts/argparser.js | 0 {rhino_modules => lib}/jsdoc/opts/args.js | 0 {rhino_modules => lib}/jsdoc/package.js | 0 {rhino_modules => lib}/jsdoc/readme.js | 0 {rhino_modules => lib}/jsdoc/schema.js | 0 {rhino_modules => lib}/jsdoc/src/filter.js | 0 {rhino_modules => lib}/jsdoc/src/handlers.js | 0 {rhino_modules => lib}/jsdoc/src/parser.js | 0 {rhino_modules => lib}/jsdoc/src/scanner.js | 0 {rhino_modules => lib}/jsdoc/tag.js | 0 .../jsdoc/tag/dictionary.js | 0 .../jsdoc/tag/dictionary/definitions.js | 0 {rhino_modules => lib}/jsdoc/tag/type.js | 0 .../jsdoc/tag/type/closureCompilerType.js | 0 .../jsdoc/tag/type/jsdocType.js | 0 {rhino_modules => lib}/jsdoc/tag/validator.js | 0 {rhino_modules => lib}/jsdoc/template.js | 0 {rhino_modules => lib}/jsdoc/tutorial.js | 0 .../jsdoc/tutorial/resolver.js | 0 {rhino_modules => lib}/jsdoc/util/doop.js | 0 {rhino_modules => lib}/jsdoc/util/dumper.js | 0 {rhino_modules => lib}/jsdoc/util/error.js | 0 {rhino_modules => lib}/jsdoc/util/markdown.js | 0 .../jsdoc/util/templateHelper.js | 0 test/README.md | 2 +- test/specs/jsdoc/src/parser.js | 2 +- test/specs/jshint/jshint-clean.js | 4 +- test/specs/{ => rhino}/fs.js | 0 test/specs/{ => rhino}/os.js | 0 test/specs/{ => rhino}/path.js | 0 39 files changed, 32 insertions(+), 35 deletions(-) rename {rhino_modules => lib}/jsdoc/augment.js (100%) rename {rhino_modules => lib}/jsdoc/borrow.js (100%) rename {rhino_modules => lib}/jsdoc/config.js (100%) rename {rhino_modules => lib}/jsdoc/doclet.js (100%) rename {rhino_modules => lib}/jsdoc/name.js (100%) rename {rhino_modules => lib}/jsdoc/opts/argparser.js (100%) rename {rhino_modules => lib}/jsdoc/opts/args.js (100%) rename {rhino_modules => lib}/jsdoc/package.js (100%) rename {rhino_modules => lib}/jsdoc/readme.js (100%) rename {rhino_modules => lib}/jsdoc/schema.js (100%) rename {rhino_modules => lib}/jsdoc/src/filter.js (100%) rename {rhino_modules => lib}/jsdoc/src/handlers.js (100%) rename {rhino_modules => lib}/jsdoc/src/parser.js (100%) rename {rhino_modules => lib}/jsdoc/src/scanner.js (100%) rename {rhino_modules => lib}/jsdoc/tag.js (100%) rename {rhino_modules => lib}/jsdoc/tag/dictionary.js (100%) rename {rhino_modules => lib}/jsdoc/tag/dictionary/definitions.js (100%) rename {rhino_modules => lib}/jsdoc/tag/type.js (100%) rename {rhino_modules => lib}/jsdoc/tag/type/closureCompilerType.js (100%) rename {rhino_modules => lib}/jsdoc/tag/type/jsdocType.js (100%) rename {rhino_modules => lib}/jsdoc/tag/validator.js (100%) rename {rhino_modules => lib}/jsdoc/template.js (100%) rename {rhino_modules => lib}/jsdoc/tutorial.js (100%) rename {rhino_modules => lib}/jsdoc/tutorial/resolver.js (100%) rename {rhino_modules => lib}/jsdoc/util/doop.js (100%) rename {rhino_modules => lib}/jsdoc/util/dumper.js (100%) rename {rhino_modules => lib}/jsdoc/util/error.js (100%) rename {rhino_modules => lib}/jsdoc/util/markdown.js (100%) rename {rhino_modules => lib}/jsdoc/util/templateHelper.js (100%) rename test/specs/{ => rhino}/fs.js (100%) rename test/specs/{ => rhino}/os.js (100%) rename test/specs/{ => rhino}/path.js (100%) diff --git a/README.md b/README.md index c25b6ed2..93beb25a 100644 --- a/README.md +++ b/README.md @@ -83,7 +83,7 @@ Or on OS X, Linux, and other POSIX-compliant systems: If you can't get the short-form commands to work, try invoking Java directly: java -cp lib/js.jar org.mozilla.javascript.tools.debugger.Main \ - -debug -modules node_modules -modules rhino_modules -modules . \ + -debug -modules node_modules -modules rhino -modules lib -modules . \ jsdoc.js your/script.js Note: `--debug` must be the first argument to the short-form command. diff --git a/jsdoc b/jsdoc index 4e3e84d6..106aa62e 100755 --- a/jsdoc +++ b/jsdoc @@ -36,9 +36,9 @@ if test "$1" = "-T" then echo "Running Tests" cd -P "$(dirname "$SOURCE")" - java -classpath "${BASEPATH}/rhino/js.jar" ${CMD} -opt -1 -modules "${URLPATH}/node_modules" -modules "${URLPATH}/rhino" -modules "${URLPATH}/rhino_modules" -modules "${URLPATH}" "${BASEPATH}/jsdoc.js" $ARGS --dirname="${BASEPATH}/" + java -classpath "${BASEPATH}/rhino/js.jar" ${CMD} -opt -1 -modules "${URLPATH}/node_modules" -modules "${URLPATH}/rhino" -modules "${URLPATH}/lib" -modules "${URLPATH}" "${BASEPATH}/jsdoc.js" $ARGS --dirname="${BASEPATH}/" else # normal mode should be quiet - java -classpath "${BASEPATH}/rhino/js.jar" ${CMD} -modules "${URLPATH}/node_modules" -modules "${URLPATH}/rhino" -modules "${URLPATH}/rhino_modules" -modules "${URLPATH}" "${BASEPATH}/jsdoc.js" $ARGS --dirname="${BASEPATH}/" + java -classpath "${BASEPATH}/rhino/js.jar" ${CMD} -modules "${URLPATH}/node_modules" -modules "${URLPATH}/rhino" -modules "${URLPATH}/lib" -modules "${URLPATH}" "${BASEPATH}/jsdoc.js" $ARGS --dirname="${BASEPATH}/" fi diff --git a/jsdoc.cmd b/jsdoc.cmd index 157d6314..a2ef8f11 100644 --- a/jsdoc.cmd +++ b/jsdoc.cmd @@ -36,10 +36,10 @@ IF [%1]==[--debug] ( IF [%1]==[-T] ( ECHO Running Tests - java -classpath "%_BASEPATH%/rhino/js.jar" %CMD% -opt -1 -modules "%_URLPATH%/node_modules" -modules "%_URLPATH%/rhino" -modules "%_URLPATH%/rhino_modules" -modules "%_URLPATH%" "%_BASEPATH%/jsdoc.js" %ARGS% --nocolor --dirname="%_BASEPATH%/ + java -classpath "%_BASEPATH%/rhino/js.jar" %CMD% -opt -1 -modules "%_URLPATH%/node_modules" -modules "%_URLPATH%/rhino" -modules "%_URLPATH%/lib" -modules "%_URLPATH%" "%_BASEPATH%/jsdoc.js" %ARGS% --nocolor --dirname="%_BASEPATH%/ ) ELSE ( REM normal mode should be quiet - java -classpath "%_BASEPATH%/rhino/js.jar" %CMD% -modules "%_URLPATH%/node_modules" -modules "%_URLPATH%/rhino" -modules "%_URLPATH%/rhino_modules" -modules "%_URLPATH%" "%_BASEPATH%/jsdoc.js" %ARGS% --dirname="%_BASEPATH%/ + java -classpath "%_BASEPATH%/rhino/js.jar" %CMD% -modules "%_URLPATH%/node_modules" -modules "%_URLPATH%/rhino" -modules "%_URLPATH%/lib" -modules "%_URLPATH%" "%_BASEPATH%/jsdoc.js" %ARGS% --dirname="%_BASEPATH%/ ) ENDLOCAL diff --git a/jsdoc.js b/jsdoc.js index e526a4e2..166a2b2b 100644 --- a/jsdoc.js +++ b/jsdoc.js @@ -22,10 +22,25 @@ env = { }, /** - The type of VM that is executing jsdoc. - @type string - */ - vm: '', + * The type of VM that is executing jsdoc: + * + * + `rhino`: Mozilla Rhino. + * + `node`: Node.js. + * + * **Note**: Rhino is the only VM that is currently supported. + * @type string + */ + vm: (function() { + if (typeof Packages === 'object' && + Object.prototype.toString.call(Packages) === '[object JavaPackage]') { + return 'rhino'; + } else if ( require && require.main && module && (require.main === module) ) { + return 'node'; + } else { + // unknown VM + throw new Error('Unable to identify the current JavaScript runtime.'); + } + })(), /** The command line arguments passed into jsdoc. @@ -56,8 +71,9 @@ env = { args = Array.prototype.slice.call(arguments, 0); -// rhino has no native way to get the base dirname of the currently running script -// so this information must be manually passed in from the command line +// Rhino has no native way to get the base dirname of the current script, +// so this information must be manually passed in from the command line. +// TODO: should only run this on Rhino for (var i = 0; i < args.length; i++) { if ( /^--dirname(?:=(.+?)(\/|\/\.)?)?$/i.test(args[i]) ) { if (RegExp.$1) { @@ -70,9 +86,9 @@ for (var i = 0; i < args.length; i++) { } } } - env.args = args; +// TODO: should only run this on Rhino load(env.dirname + '/rhino/rhino-shim.js'); //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~// @@ -197,23 +213,6 @@ function main() { taffy = require('taffydb').taffy, Config = require('jsdoc/config'); - /** - Detect the type of VM running jsdoc. - **Note**: Rhino is the only VM that is currently supported. - @return {string} rhino|node - */ - function detectVm() { - if (typeof Packages === "object" && - Object.prototype.toString.call(Packages) === "[object JavaPackage]") { - return "rhino"; - } else if ( require && require.main && module && (require.main === module) ) { - return "node"; - } else { - // unknown VM - return; - } - } - /** * If the current VM is Rhino, convert a path to a URI that meets the operating system's * requirements. Otherwise, return the original path. @@ -287,8 +286,6 @@ function main() { return result; } - env.vm = detectVm(); - var defaultOpts = { destination: './out/' }; diff --git a/rhino_modules/jsdoc/augment.js b/lib/jsdoc/augment.js similarity index 100% rename from rhino_modules/jsdoc/augment.js rename to lib/jsdoc/augment.js diff --git a/rhino_modules/jsdoc/borrow.js b/lib/jsdoc/borrow.js similarity index 100% rename from rhino_modules/jsdoc/borrow.js rename to lib/jsdoc/borrow.js diff --git a/rhino_modules/jsdoc/config.js b/lib/jsdoc/config.js similarity index 100% rename from rhino_modules/jsdoc/config.js rename to lib/jsdoc/config.js diff --git a/rhino_modules/jsdoc/doclet.js b/lib/jsdoc/doclet.js similarity index 100% rename from rhino_modules/jsdoc/doclet.js rename to lib/jsdoc/doclet.js diff --git a/rhino_modules/jsdoc/name.js b/lib/jsdoc/name.js similarity index 100% rename from rhino_modules/jsdoc/name.js rename to lib/jsdoc/name.js diff --git a/rhino_modules/jsdoc/opts/argparser.js b/lib/jsdoc/opts/argparser.js similarity index 100% rename from rhino_modules/jsdoc/opts/argparser.js rename to lib/jsdoc/opts/argparser.js diff --git a/rhino_modules/jsdoc/opts/args.js b/lib/jsdoc/opts/args.js similarity index 100% rename from rhino_modules/jsdoc/opts/args.js rename to lib/jsdoc/opts/args.js diff --git a/rhino_modules/jsdoc/package.js b/lib/jsdoc/package.js similarity index 100% rename from rhino_modules/jsdoc/package.js rename to lib/jsdoc/package.js diff --git a/rhino_modules/jsdoc/readme.js b/lib/jsdoc/readme.js similarity index 100% rename from rhino_modules/jsdoc/readme.js rename to lib/jsdoc/readme.js diff --git a/rhino_modules/jsdoc/schema.js b/lib/jsdoc/schema.js similarity index 100% rename from rhino_modules/jsdoc/schema.js rename to lib/jsdoc/schema.js diff --git a/rhino_modules/jsdoc/src/filter.js b/lib/jsdoc/src/filter.js similarity index 100% rename from rhino_modules/jsdoc/src/filter.js rename to lib/jsdoc/src/filter.js diff --git a/rhino_modules/jsdoc/src/handlers.js b/lib/jsdoc/src/handlers.js similarity index 100% rename from rhino_modules/jsdoc/src/handlers.js rename to lib/jsdoc/src/handlers.js diff --git a/rhino_modules/jsdoc/src/parser.js b/lib/jsdoc/src/parser.js similarity index 100% rename from rhino_modules/jsdoc/src/parser.js rename to lib/jsdoc/src/parser.js diff --git a/rhino_modules/jsdoc/src/scanner.js b/lib/jsdoc/src/scanner.js similarity index 100% rename from rhino_modules/jsdoc/src/scanner.js rename to lib/jsdoc/src/scanner.js diff --git a/rhino_modules/jsdoc/tag.js b/lib/jsdoc/tag.js similarity index 100% rename from rhino_modules/jsdoc/tag.js rename to lib/jsdoc/tag.js diff --git a/rhino_modules/jsdoc/tag/dictionary.js b/lib/jsdoc/tag/dictionary.js similarity index 100% rename from rhino_modules/jsdoc/tag/dictionary.js rename to lib/jsdoc/tag/dictionary.js diff --git a/rhino_modules/jsdoc/tag/dictionary/definitions.js b/lib/jsdoc/tag/dictionary/definitions.js similarity index 100% rename from rhino_modules/jsdoc/tag/dictionary/definitions.js rename to lib/jsdoc/tag/dictionary/definitions.js diff --git a/rhino_modules/jsdoc/tag/type.js b/lib/jsdoc/tag/type.js similarity index 100% rename from rhino_modules/jsdoc/tag/type.js rename to lib/jsdoc/tag/type.js diff --git a/rhino_modules/jsdoc/tag/type/closureCompilerType.js b/lib/jsdoc/tag/type/closureCompilerType.js similarity index 100% rename from rhino_modules/jsdoc/tag/type/closureCompilerType.js rename to lib/jsdoc/tag/type/closureCompilerType.js diff --git a/rhino_modules/jsdoc/tag/type/jsdocType.js b/lib/jsdoc/tag/type/jsdocType.js similarity index 100% rename from rhino_modules/jsdoc/tag/type/jsdocType.js rename to lib/jsdoc/tag/type/jsdocType.js diff --git a/rhino_modules/jsdoc/tag/validator.js b/lib/jsdoc/tag/validator.js similarity index 100% rename from rhino_modules/jsdoc/tag/validator.js rename to lib/jsdoc/tag/validator.js diff --git a/rhino_modules/jsdoc/template.js b/lib/jsdoc/template.js similarity index 100% rename from rhino_modules/jsdoc/template.js rename to lib/jsdoc/template.js diff --git a/rhino_modules/jsdoc/tutorial.js b/lib/jsdoc/tutorial.js similarity index 100% rename from rhino_modules/jsdoc/tutorial.js rename to lib/jsdoc/tutorial.js diff --git a/rhino_modules/jsdoc/tutorial/resolver.js b/lib/jsdoc/tutorial/resolver.js similarity index 100% rename from rhino_modules/jsdoc/tutorial/resolver.js rename to lib/jsdoc/tutorial/resolver.js diff --git a/rhino_modules/jsdoc/util/doop.js b/lib/jsdoc/util/doop.js similarity index 100% rename from rhino_modules/jsdoc/util/doop.js rename to lib/jsdoc/util/doop.js diff --git a/rhino_modules/jsdoc/util/dumper.js b/lib/jsdoc/util/dumper.js similarity index 100% rename from rhino_modules/jsdoc/util/dumper.js rename to lib/jsdoc/util/dumper.js diff --git a/rhino_modules/jsdoc/util/error.js b/lib/jsdoc/util/error.js similarity index 100% rename from rhino_modules/jsdoc/util/error.js rename to lib/jsdoc/util/error.js diff --git a/rhino_modules/jsdoc/util/markdown.js b/lib/jsdoc/util/markdown.js similarity index 100% rename from rhino_modules/jsdoc/util/markdown.js rename to lib/jsdoc/util/markdown.js diff --git a/rhino_modules/jsdoc/util/templateHelper.js b/lib/jsdoc/util/templateHelper.js similarity index 100% rename from rhino_modules/jsdoc/util/templateHelper.js rename to lib/jsdoc/util/templateHelper.js diff --git a/test/README.md b/test/README.md index 7e68ea45..dc8f9d96 100644 --- a/test/README.md +++ b/test/README.md @@ -16,7 +16,7 @@ Or on OS X, Linux, and other POSIX-compliant platforms: If you can't get the short-form commands to work, try invoking Java directly: java -cp lib/js.jar org.mozilla.javascript.tools.shell.Main \ - -modules node_modules -modules rhino_modules -modules . \ + -modules node_modules -modules rhino -modules lib -modules . \ jsdoc.js -T Writing Tests diff --git a/test/specs/jsdoc/src/parser.js b/test/specs/jsdoc/src/parser.js index f07e7351..4e24e08b 100644 --- a/test/specs/jsdoc/src/parser.js +++ b/test/specs/jsdoc/src/parser.js @@ -45,7 +45,7 @@ describe("jsdoc/src/parser", function() { var fs = require("fs"), path = require("path"), parserSrc = "javascript:" + fs.readFileSync( path.join(__dirname, - "rhino_modules", "jsdoc", "src", "parser.js") ), + "lib", "jsdoc", "src", "parser.js") ), parse = function() { parser.parse(parserSrc); }; diff --git a/test/specs/jshint/jshint-clean.js b/test/specs/jshint/jshint-clean.js index 542acbf9..2bc9072a 100644 --- a/test/specs/jshint/jshint-clean.js +++ b/test/specs/jshint/jshint-clean.js @@ -52,8 +52,8 @@ describe('jshint-clean', function() { // check all .js files unless they're tests; rhino shim files that probably can't be // delinted; or third-party modules source = { - includePattern: '.+[\\|/]rhino_modules[\\|/].+\\.js$|.+[\\|/]plugins[\\|/]\\w+\\.js$', - excludePattern: '.+[\\|/]test[\\|/].+' + includePattern: '.+[\\|/]lib[\\|/].+\\.js$|.+[\\|/]plugins[\\|/]\\w+\\.js$', + excludePattern: '.+[\\|/]test[\\|/].+|.+[\\|/]node_modules[\\|/].+|.+[\\|/]Jake[\\|/].+' }; filter = new (require('jsdoc/src/filter').Filter)(source); diff --git a/test/specs/fs.js b/test/specs/rhino/fs.js similarity index 100% rename from test/specs/fs.js rename to test/specs/rhino/fs.js diff --git a/test/specs/os.js b/test/specs/rhino/os.js similarity index 100% rename from test/specs/os.js rename to test/specs/rhino/os.js diff --git a/test/specs/path.js b/test/specs/rhino/path.js similarity index 100% rename from test/specs/path.js rename to test/specs/rhino/path.js