Jsrun

From ProgClub
Revision as of 15:14, 11 December 2017 by John (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Jsrun is Shawn A. Van Ness's JScript.NET utility software. For other projects see projects.

Status

Released!

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. E.g.:

svn co https://www.progclub.org/svn/pcrepo/jsrun/tags/latest jsrun

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.

jsrun.cmd

The jsrun.cmd command script is the launcher/runner for all Jsrun JScript.NET utilities. For help with jsrun use:

jsrun /?

For a list of available scripts use:

jsrun list

To run a script use:

jsrun <scriptName> {<arg>}

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.

Note: there are no technical specifications for this software being provided. If you're interested in how jsrun.cmd or the associated JScript.NET scripts work you are invited to read the source code.

Notes

Installation notes

To install jsrun pick a directory to keep the jsrun files in, e.g. K:\progclub. Then:

cd /d K:\progclub
svn co https://www.progclub.org/svn/pcrepo/jsrun/tags/latest jsrun

That will create a directory K:\progclub\jsrun where the latest release of jsrun will be installed. To update your installation:

cd /d K:\progclub\jsrun
svn update

To make jsrun available in your environment add the 'bin' subdirectory to your %PATH% environment variable. On Windows click the Start button, right-click My Computer, select Properties, select Advanced, click Environment Variables, scroll down to the Path system variable and add ";K:\progclub\jsrun\bin" to the end of the existing value.

Note: in all of the above examples you will need to substitute your actual installation directory for K:\progclub.

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:

Nothing planned at this time.

Done

Stuff that's done. Latest stuff on bottom of list.

2012-03-25

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.
  • JE: Have Shawn pick an open-source license (recommend New BSD).