Version Numbering

SB follows the following version numbering system for ''vA.B.C'':

• ''A'' of zero means alpha/beta, first production will be ''1''. If ''A'' is odd or even currently has no special meaning.

• If ''B'' is odd it's a pre-release for the next version of ''B+1''. Thus ''0.5.nnn'' is a pre-release for the next ''0.6''.

• ''C'' is sequence number.

So for example, currently ''0.5.159'' is a pre-release for ''0.6.0'', because no ''0.6'' has been released.

Optionally, a repo might be called "snackabraABC" for major changes, for example ''0.5.159'' is currently released as ''snackabra060-0.5.159''.

A few notes / reiterations:

• there is no specific relationship between a pre-release and the next stable. For example ''0.5.185'' might be the last pre-release before ''0.6.0'', and ''0.5.203'' might later be the last pre-release before ''0.6.1''.

• odd vs even only has meaning for the middle version number (''B'').

• you can always pick the highest version number and you will get most recent and stable version.

• you can always pick the highest ''a.b.c'' where ''b'' is odd and you will get the latest development versions.

• if (and only if) ''B'' is even, then ''A.B.n+1'' will try the hardest not to have breaking changes from ''A.B.n''.

• conversely, if ''B'' is odd, then ''A.B.m'' can have any sort of breaking changes vs any ''A.B.n'' where m is greater than n.

Snackabra Javascript Library

JSDOC is used for javascript documentation. See https://google.github.io/styleguide/jsguide.html for format. Currently the library needs to be explicitly copied into the snackabra-jslib directory in https://github.com/snackabra/docs

If you would like to contribute or help out with the snackabra project, please feel free to reach out to us at snackabra@gmail.com or snackabra@protonmail.com

Snackabra is licensed under GPL-v3, see GPL v3 license file for details.

Note: this module is under active development

Usage in Node

Install:

npm install snackabra -g

A couple of ways to load ES module version in nodejs:

// method 1:
import * as sb from 'snackabra';
console.log(sb.str2ab('hello'));

// method 2 (the default export)
import Snackabra from 'snackabra';
console.log(Snackabra.str2ab('hello'));

// method 3
const sb = await import('snackabra');
console.log(sb.str2ab('hello'));

// method 4
import {str2ab} from 'snackabra';
console.log(str2ab('hello'));

Usage in browsers

From a local copy:

  <script type="module" src="browser.mjs"></script>

Or from npm package:

  <!-- This gets latest version: -->
  <script type="module" src="https://unpkg.com/snackabra/browser.mjs"></script>
  <!-- This gets specific version: -->
  <script type="module" src="https://unpkg.com/snackabra@0.4.10/browser.mjs"></script>

Dynamic import of latest version from unpkg:

  <h2>Test Results</h2>
  <p id='testResults'></p>
  <script>
    import('https://unpkg.com/snackabra/browser.mjs').then((sb) => {
      let z = document.getElementById("testResults");
      z.innerHTML += `Test: ${sb.str2ab('hello')}`;
    });
  </script>

You can also access the loaded functions globally, e.g. window.Snackabra.str2ab('hello').

Development

First time around, remember to:

# install devDependencies
npm install

Build components (and install dependencies):

npm pack

This will generate the browser.mjs and index.mjs files; the former is for use in browsers, the latter for use with node.

Publishing

If you have write/admin access to npmjs:

npm login  # if needed
npm publish

Remember to bump the version number in before publishing.

Package should get updated at https://www.npmjs.com/package/snackabra

LICENSE

Copyright (c) 2016-2021 Magnusson Institute, All Rights Reserved.

"Snackabra" is a registered trademark

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, the above trademark 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 NON-INFRINGEMENT. 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.

See GPL v3 license file for details.