extendscript-logger/README.md

Logging for Adobe ExtendScript capable applications.

# Overview

extendscript-logger provides file logging functionality to Adobe applications that can use ExtendScript.

# Installation

Simply install it like any other npm package.

```sh
npm install extendscript-logger

```

Add the following code to any ExtendScript (`*.jsx`) file you want to have a Logger instance available.

```js
var Global = Global || {};
Global.rootPath = new File($.fileName).parent;
$.evalFile(Global.rootPath + '/node_modules/extendscript-logger/index.jsx');
Global.logger = new Logger(Global.rootPath+'/log/test.log', 'DEBUG');
```

# Usage

Logger provides the following methods for logging output.

```js
Global.logger.debug('Debug message');
Global.logger.info([1, "Random string"]);
Global.logger.notice({foo:"bar"});
Global.logger.valid('Validations complete.');
Global.logger.warn("Danger, Will Robinson!");
Global.logger.error("Crap! Something went wrong.");
Global.logger.critical("DEFCON 1! Seek shelter.");
```

# Testing

`npm test` or `test/run`.

Output should look like:

```
me@host extendscript-logger|master$ test/run
2020-03-03T11:44:99|INFO|***************************
2020-03-03T11:44:00|INFO|Jasmine ExtendScript Runner
2020-03-03T11:44:00|INFO|***************************
2020-03-03T11:44:00|WARN|To prevent odd errors, usually methods not being defined, login into Adobe Creative Cloud and verify all modal dialog boxes are closed. If tests are not running as expected, try restarting the application.
2020-03-03T11:44:00|INFO|Loading all specs in /Users/spyle/projects/extendscript-logger/test/spec
2020-03-03T11:44:49|INFO|20 specs, 0 failures
2020-03-03T11:44:49|INFO|Finished in 0.469 seconds
```

# NPM Release Tasks

1. Update `package.json` version number
1. `npm install` to update package lock.
1. Ensure tests pass.
1. Update `CHANGELOG.md` with changes since last release.
1. Check them all into the repository.
1. `git tag -a <version> -m <version>; git push --tags`
1. `npm publish` to deploy the release to npm.

# jasminejsx Cyclical Dependency

When making changes to jasminejsx and extendscript-logger that depend on each others (e.g. global variables, libraries), publishing new versions can be tricky. Here is the easiest way I've found to do this:

1. Clone both repositories to your projects directory.
1. Remove existing `node_modules/extendscript-logger` and `node_modules/jasminejsx` directories.
1. Symlink the those to the cloned versions:
    ```sh
    cd node_modules
    ln -s ../../jasminejsx
    ln -s ../.. extendscript-logger
    ```
1. Make changes to the cloned repositories.
1. Ensure tests pass in both repositories.
1. Release extendscript-logger first (e.g. 0.1.0). Since jasminejsx is a devDependency, it shouldn't break upstream packages. See NPM Release Tasks above.
1. Release jasminejsx with the new version of extendscript-logger (e.g. 0.2.0). This should be done second as extendscript-logger is a dependency and required to have a working version.
1. Release a patched version of extendscript-logger with the new version of jasminejsx (e.g. 0.1.1).