Difference between revisions of "Jsrun"
m (moved SVN-js.net to Jsrun) |
(Preparing for first release.) |
||
Line 1: | Line 1: | ||
− | + | Jsrun is Shawn A. Van Ness's JScript.NET utility software. For other projects see [[projects]]. | |
= Status = | = Status = | ||
Line 17: | Line 17: | ||
Upstream contributors: | Upstream contributors: | ||
− | * Shawn A. Van Ness | + | * [http://www.windojitsu.com/ Shawn A. Van Ness] |
== Copyright == | == Copyright == | ||
Line 25: | Line 25: | ||
== License == | == License == | ||
− | + | Licensed under the [[New BSD license|New BSD]] license. | |
= Resources = | = Resources = | ||
− | == | + | == Download == |
− | + | There aren't any download files for this project -- grab the code from svn. | |
== Source code == | == Source code == | ||
Line 37: | Line 37: | ||
The repository can be browsed online: | The repository can be browsed online: | ||
− | https://www.progclub.org/pcrepo/ | + | https://www.progclub.org/pcrepo/jsrun/trunk |
The latest stable released version of the code is available from: | The latest stable released version of the code is available from: | ||
− | https://www.progclub.org/svn/pcrepo/ | + | https://www.progclub.org/svn/pcrepo/jsrun/tags/latest |
Or if you want the latest version for development purposes: | Or if you want the latest version for development purposes: | ||
− | svn://www.progclub.org/svn/pcrepo/ | + | svn://www.progclub.org/svn/pcrepo/jsrun/trunk |
== Links == | == Links == | ||
Line 55: | Line 55: | ||
== Functional specification == | == Functional specification == | ||
− | The functional specification describes what the | + | The functional specification describes what the feature does and how to use it. |
+ | |||
+ | === Base64DecodeFile.js === | ||
+ | |||
+ | Decodes base64 from stdin stream, and writes result to outputFile. | ||
+ | |||
+ | Usage: | ||
+ | |||
+ | jsrun Base64DecodeFile.js outputFile | ||
+ | |||
+ | === Base64EncodeFile.js === | ||
+ | |||
+ | Encodes data from sourceFile and emits base64 to stdout. | ||
+ | |||
+ | Usage: | ||
+ | |||
+ | jsrun Base64EncodeFile.js sourceFile | ||
+ | |||
+ | === BeautifyXml.js === | ||
+ | |||
+ | Pretty prints an XML file. | ||
+ | |||
+ | Usage: | ||
+ | |||
+ | jsrun BeautifyXml.js sourceFile outputFile | ||
+ | |||
+ | === CountWords.js === | ||
+ | |||
+ | Tokenizes a html or xml document, and counts the words of "content" within. | ||
+ | |||
+ | Usage: | ||
+ | |||
+ | jsrun CountWords.js sourceFile | ||
+ | |||
+ | === DecodeVer.js === | ||
+ | |||
+ | Convert standard .NET version number to a build timestamp. | ||
+ | |||
+ | Usage: | ||
+ | |||
+ | jsrun DecodeVer.js versionString | ||
+ | |||
+ | Example: | ||
+ | |||
+ | jsrun DecodeVer.js 1.0.1699.29632 | ||
+ | 2004-08-26 17:27:44Z | ||
+ | |||
+ | === PrintCmdArgs.js === | ||
+ | |||
+ | Prints any command line arguments received by the compiled JScript.NET executable called from jsrun.cmd. | ||
+ | |||
+ | Usage: | ||
+ | |||
+ | jsrun PrintCmdArgs.js arg1 arg2 ... | ||
+ | |||
+ | === Unicodify.js === | ||
+ | |||
+ | Creates a UTF-8 encoded copy of sourceFile, named "sourceFile.utf8". | ||
+ | |||
+ | Usage: | ||
+ | |||
+ | jsrun Unicodify.js sourceFile | ||
+ | |||
+ | === UuidGen.js === | ||
+ | |||
+ | Generates a GUID. | ||
+ | |||
+ | Usage: | ||
+ | |||
+ | jsrun UuidGen.js | ||
== Technical specification == | == Technical specification == | ||
− | The technical specification describes how the | + | The technical specification describes how the feature works. |
+ | |||
+ | === Base64DecodeFile.js technicalities === | ||
+ | |||
+ | === Base64EncodeFile.js technicalities === | ||
+ | |||
+ | === BeautifyXml.js technicalities === | ||
+ | |||
+ | === CountWords.js technicalities === | ||
+ | |||
+ | === DecodeVer.js technicalities === | ||
+ | |||
+ | === PrintCmdArgs.js technicalities === | ||
+ | |||
+ | === Unicodify.js technicalities === | ||
+ | |||
+ | === UuidGen.js technicalities === | ||
= Notes = | = Notes = | ||
Line 67: | Line 152: | ||
If you are interested in incorporating this software into your project, here's what you need to know: | If you are interested in incorporating this software into your project, here's what you need to know: | ||
− | + | Copy and paste your way to victory! Code should be easy to port to C#. | |
== Notes for developers == | == Notes for developers == | ||
Line 73: | Line 158: | ||
If you're looking to set up a development environment for this project here's what you need to know: | If you're looking to set up a development environment for this project here's what you need to know: | ||
− | + | Check out the code from Subversion: | |
+ | |||
+ | svn://www.progclub.org/svn/pcrepo/jsrun/trunk | ||
+ | |||
+ | Then add new JScript.NET features in the 'src' directory, work on the code runner jsrun.cmd in the 'bin' directory or the project documentation in the 'doc' directory. | ||
= Tasks = | = Tasks = | ||
Line 81: | Line 170: | ||
Things to do, in rough order of priority: | Things to do, in rough order of priority: | ||
− | |||
* Have Shawn pick an open-source license (recommend New BSD). | * Have Shawn pick an open-source license (recommend New BSD). | ||
− | |||
− | |||
− | |||
[[Category:TODO]] | [[Category:TODO]] | ||
Line 92: | Line 177: | ||
Stuff that's done. Latest stuff on bottom of list. | Stuff that's done. Latest stuff on bottom of list. | ||
+ | |||
+ | === 2012-08-13 === | ||
+ | |||
+ | * [[User:John|JE]]: Renamed the [https://www.progclub.org/pcrepo/jsrun/trunk project in svn]. | ||
+ | * [[User:John|JE]]: Confirm project name 'SVN-js.net' with Shawn. | ||
+ | ** Note: project renamed to 'jsrun'. | ||
+ | * [[User:John|JE]]: Copy in existing JScript.NET scripts. | ||
+ | * [[User:John|JE]]: Tidy up existing code. | ||
+ | ** Note: JE changed jsrun.cmd a little bit to use a 'bin'/'src' separation for the runner and source files. SVN tidied up the code a bit before sending it to JE. | ||
+ | * [[User:John|JE]]: Write a build script that pre-compiles everything (keep the binaries in the repo). | ||
+ | ** Note: not doing this any more. Will use the jsrun.cmd code runner. | ||
=== 2012-03-25 === | === 2012-03-25 === |
Revision as of 11:49, 13 August 2012
Jsrun is Shawn A. Van Ness's JScript.NET utility software. For other projects see projects.
Status
Under way. Not released yet, there's stuff TODO.
Administration
Contributors
Members who have contributed to this project. Newest on top.
All contributors have agreed to the terms of the Contributor License Agreement. This excludes any upstream contributors who tend to have different administrative frameworks.
Upstream contributors:
Copyright
Copyright 2012, Contributors.
License
Licensed under the New BSD license.
Resources
Download
There aren't any download files for this project -- grab the code from svn.
Source code
The repository can be browsed online:
https://www.progclub.org/pcrepo/jsrun/trunk
The latest stable released version of the code is available from:
https://www.progclub.org/svn/pcrepo/jsrun/tags/latest
Or if you want the latest version for development purposes:
svn://www.progclub.org/svn/pcrepo/jsrun/trunk
Links
No links at this time.
Specifications
Functional specification
The functional specification describes what the feature does and how to use it.
Base64DecodeFile.js
Decodes base64 from stdin stream, and writes result to outputFile.
Usage:
jsrun Base64DecodeFile.js outputFile
Base64EncodeFile.js
Encodes data from sourceFile and emits base64 to stdout.
Usage:
jsrun Base64EncodeFile.js sourceFile
BeautifyXml.js
Pretty prints an XML file.
Usage:
jsrun BeautifyXml.js sourceFile outputFile
CountWords.js
Tokenizes a html or xml document, and counts the words of "content" within.
Usage:
jsrun CountWords.js sourceFile
DecodeVer.js
Convert standard .NET version number to a build timestamp.
Usage:
jsrun DecodeVer.js versionString
Example:
jsrun DecodeVer.js 1.0.1699.29632 2004-08-26 17:27:44Z
PrintCmdArgs.js
Prints any command line arguments received by the compiled JScript.NET executable called from jsrun.cmd.
Usage:
jsrun PrintCmdArgs.js arg1 arg2 ...
Unicodify.js
Creates a UTF-8 encoded copy of sourceFile, named "sourceFile.utf8".
Usage:
jsrun Unicodify.js sourceFile
UuidGen.js
Generates a GUID.
Usage:
jsrun UuidGen.js
Technical specification
The technical specification describes how the feature works.
Base64DecodeFile.js technicalities
Base64EncodeFile.js technicalities
BeautifyXml.js technicalities
CountWords.js technicalities
DecodeVer.js technicalities
PrintCmdArgs.js technicalities
Unicodify.js technicalities
UuidGen.js technicalities
Notes
Notes for implementers
If you are interested in incorporating this software into your project, here's what you need to know:
Copy and paste your way to victory! Code should be easy to port to C#.
Notes for developers
If you're looking to set up a development environment for this project here's what you need to know:
Check out the code from Subversion:
svn://www.progclub.org/svn/pcrepo/jsrun/trunk
Then add new JScript.NET features in the 'src' directory, work on the code runner jsrun.cmd in the 'bin' directory or the project documentation in the 'doc' directory.
Tasks
TODO
Things to do, in rough order of priority:
- Have Shawn pick an open-source license (recommend New BSD).
Done
Stuff that's done. Latest stuff on bottom of list.
2012-08-13
- JE: Renamed the project in svn.
- JE: Confirm project name 'SVN-js.net' with Shawn.
- Note: project renamed to 'jsrun'.
- JE: Copy in existing JScript.NET scripts.
- JE: Tidy up existing code.
- Note: JE changed jsrun.cmd a little bit to use a 'bin'/'src' separation for the runner and source files. SVN tidied up the code a bit before sending it to JE.
- JE: Write a build script that pre-compiles everything (keep the binaries in the repo).
- Note: not doing this any more. Will use the jsrun.cmd code runner.
2012-03-25
- JE: Create project page.
- JE: Create the project in svn.