Giter VIP home page Giter VIP logo

node-sgc's Introduction

node-sgc

An node module to read and write Synergy's configuration file format

This is pretty much only useful if you're writing an interface to Synergy.

Run

  1. Have Node.js

  2. Run npm install in the project directory

  3. Run npm test in the project directory

Usage

Are you writing an interface to Synergy?

Really? Are you sure?

Okay... I mean, if you are writing an interface to Synergy, then this could be very helpful, but chances are you're only continuing reading this because, I suppose, it's more conversational than most README documents.

At any rate, there's SGC.parse and SGC.stringify, mimicking the JSON API.

var SGC = require("SGC");
var fs = require("fs");
var config = SGC.parse(fs.readFileSync("synergy-config.sgc", "utf8"));
console.log(config.screens, config.links, config.aliases, config.options);
fs.writeFileSync("synergy-config.sgc", SGC.stringify(config), {encoding: "utf8"}));

Both functions may throw errors.

Metadata Retention (:lock_with_ink_pen:)

It tries to retain your preferred formatting a bit. It stores the first indentation it finds in config.meta.tab and uses that later if you stringify it.

It also preserves some comments, sometimes in the wrong places.

It can't be perfect. The file changes.

After all, sometimes you don't want it to retain a comment, for example if you change the switch delay, this comment becomes outdated:

switchDelay = 500 # half of a second

I think it would be awesome if someone started work on a comprehensive system for loading, modifying, and saving structured documents while retaining as much metadata and formatting as possible.

∑SYN.Act =∑R-*I(CRed+COOP++AUnimit.)*V(Cust.+Info.)*cc

node-sgc's People

Contributors

1j01 avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.