node-spreadsheet-column

Convert spreadsheet columns coordinates to numeric coordinates and reverse too.

This is Node version of my PHP library coord2coord.

Why?

Sometimes, when you develop some code about some CSV or something like that, you have reference given by some people using spreadsheet value (column A, AA, Z…) or index value (1, 2, 3) or even index value starting to zero (0, 1, 2…).

So, this little library deals with that. So, you can easily switch from one system to another.

How?

You can play with it using two ways:

• By using library to use it into your code
• By using CLI script

Install it!

Simple. Just use npm.

To use it into your project:

npm install --save spreadsheet-column

To use it as CLI application:

npm install -g spreadsheet-column

Use it into your code!

Example is better than long blahblah, so:

var Spreadsheetcolumn = require('spreadsheet-column');
var sc = new SpreadsheetColumn();

console.log(sc.fromInt(1)); // "A"
console.log(sc.fromInt(26)); // "Z"
console.log(sc.fromInt(27)); // "AA"
console.log(sc.fromInt(28)); // "AB"

console.log(sc.fromStr('A')); // 1
console.log(sc.fromStr('Z')); // 26
console.log(sc.fromStr('AA')); // 27
console.log(sc.fromStr('AB')); // 28

Simple, isn’t it? You can even use zero-indexed way too, just tell it when you create object:

var Spreadsheetcolumn = require('spreadsheet-column');
var scz = new SpreadsheetColumn({zero: true});

console.log(scz.fromInt(0)); // "A"
console.log(scz.fromInt(25)); // "Z"
console.log(scz.fromInt(26)); // "AA"
console.log(scz.fromInt(27)); // "AB"

console.log(scz.fromStr('A')); // 0
console.log(scz.fromStr('Z')); // 25
console.log(scz.fromStr('AA')); // 26
console.log(scz.fromStr('AB')); // 27

A new feature allows you to have collection of results from a string having digits and/or letters:

var Spreadsheetcolumn = require('spreadsheet-column');
var sc = new SpreadsheetColumn();
console.log(sc.fromAny('V 4 L iD'));
// with custom separator too:
console.log(sc.fromAny('V;4;L;iD'));

Previous 2 instructions will return the same following result:

[
    {
        original: "V",
        converted: 22
    },
    {
        original: 4,
        converted: "D"
    },
    {
        original: "L",
        converted: 12
    },
    {
        original: "ID",
        converted: 238
    }
]

Note: Letters are converted to uppercases.

Note 2: A group having both letters and digits throws an error. Example: V4 LI D has its first group invalid.

Use it as CLI!

Very simple:

$ spreadsheet-column A B Z 45 AA AB

Previous example gives you converting results for each values passed as arguments:

A => 1
B => 2
Z => 26
45 => AS
AA => 27
AB => 28

Starting from zero is possible too:

$ spreadsheet-column --zero A B Z 45 AA AB

It does:

A => 0
B => 1
Z => 25
45 => AT
AA => 26
AB => 27

You can choose output format, JSON or formated output (by default, seen into first example):

$ spreadsheet-column --json A 26 AA

This output produces this:

[{"original":"A","converted":1},{"original":26,"converted":"Z"},{"original":"AA","converted":27}]

You can play with standard input too, by using pipe or by inputing value using your keyboard:

$ echo '50 ME TH 1 N 6' | spreadsheet-column --stdin
$ spreadsheet-column --stdin
6
6 => F
E
E => 5
ZZ
ZZ => 702
…

Into second call, you can stop by pressing CTRL + C.

You have all this informations resumed into help: spreadsheet-column --help.

Test it!

Clone current source code, then go into the source’s directory, and install dependencies:

npm install

And then run unit tests:

npm test

License?

The MIT License (MIT)

Copyright (c) 2015 Michel Petit

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.