Nyx is a support library (gem) for Ibidem projects.

The tool is designed to be an integration tool, rather then a retrieval tool. While it will fetch the necesary files for you, it's main purpose is to manipulate and clean up those files to work as desired in the system.

Nyx also serves to centralize general purpose scripting, such as javascript/scss build processes, watchers, etc

Installing

gem install nyx

You may need to have the ruby dev tools for some dependencies.

Sample configuration

{
	"interface": "1.0.0",

	"cores": [
		{
			"repo": "https://github.com/twbs/bootstrap.git",
			"path": "src/vendor/twbs",
			"version": "v3.0.0",
			"keep": ["js", "README.md", "LICENSE"],
			"remove": ["js/tests", "js/.jshintrc"]
		},
		{
			"repo": "https://github.com/ibidem/mjolnir-backbone.git",
			"path": "src/app/extentions/mjolnir",
			"version": "1.0.0",
			"ensure": {
				"dependencies/templates": "../templates/extentions",
				"dependencies/packages": "src/packages",
				"dependencies/widgets": "src/widgets"
			},
			"remove": ["dependencies", ".gitignore", ".gitattributes"]
		}
	]
}

Quick Reference

You can get a list of all commands by just invoking nyx with no parameters.

General functions

• dependency (ie. core) integration management (nyx compile)

Other functions

• script compilation (Nyx.new.compile_scripts)
• script watch (Nyx.new.watch_scripts)
• style compilation (Nyx.new.compile_style)
• style watch (Nyx.new.watch_style)

Supported nyx.json integration options:

(ordered by processing order)

1. keep, given a set of files, removes all other files in the core

2. ensure, given a hash associating a core path with another path copies all core files to the given path if a copy of the file does not exist there yet

3. refactor, given a hash of string to string association, searches and replaces the given string in all files; if the string starts with a / then it is assumed to be a regular expression [currently not available]

4. remove, deletes the given files; used for cases where keep isn't viable