diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..4a7ea30 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,12 @@ +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[*.md] +trim_trailing_whitespace = false diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml new file mode 100644 index 0000000..ae20b99 --- /dev/null +++ b/.github/workflows/check.yaml @@ -0,0 +1,12 @@ +name: check +on: [push] +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: lts/* + - run: yarn install + - run: make check diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..91fa8cf --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/node_modules/ +npm-debug.log diff --git a/.jshintrc b/.jshintrc new file mode 100644 index 0000000..4a2f904 --- /dev/null +++ b/.jshintrc @@ -0,0 +1,14 @@ +{ + "curly": true, + "eqeqeq": true, + "eqnull": true, + "immed": true, + "latedef": "nofunc", + "newcap": true, + "noarg": true, + "node": true, + "sub": true, + "undef": true, + "unused": true, + "esversion": 11 +} diff --git a/History.md b/History.md new file mode 100644 index 0000000..e69de29 diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..9c4a0ea --- /dev/null +++ b/Makefile @@ -0,0 +1,9 @@ +check: lint test + +lint: + ./node_modules/.bin/jshint *.js lib test + +test: + node --test + +.PHONY: check lint test diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..638db02 --- /dev/null +++ b/Readme.md @@ -0,0 +1,34 @@ +[![NPM version][npm-image]][npm-url] +[![Build Status][build-image]][build-url] +[![Dependency Status][deps-image]][deps-url] + +# import-nmea + +Import NMEA files into Furkot. + +## Install + +```sh +$ npm install --save import-nmea +``` + +## Usage + +```js +var importNmea = require('import-nmea'); + +importNmea('Rainbow'); +``` + +## License + +MIT © [Damian Krzeminski](https://pirxpilot.me) + +[npm-image]: https://img.shields.io/npm/v/@furkot/import-nmea +[npm-url]: https://npmjs.org/package/@furkot/import-nmea + +[build-url]: https://github.com/furkot/import-nmea/actions/workflows/check.yaml +[build-image]: https://img.shields.io/github/actions/workflow/status/furkot/import-nmea/check.yaml?branch=main + +[deps-image]: https://img.shields.io/librariesio/release/npm/@furkot/import-nmea +[deps-url]: https://libraries.io/npm/@furkot%2Fimport-nmea diff --git a/index.js b/index.js new file mode 100644 index 0000000..f3dcb21 --- /dev/null +++ b/index.js @@ -0,0 +1 @@ +module.exports = require('./lib/import-nmea'); diff --git a/lib/import-nmea.js b/lib/import-nmea.js new file mode 100644 index 0000000..16b77f2 --- /dev/null +++ b/lib/import-nmea.js @@ -0,0 +1,4 @@ +module.exports = importNmea; + +function importNmea() { +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..4e382d9 --- /dev/null +++ b/package.json @@ -0,0 +1,28 @@ +{ + "name": "@furkot/import-nmea", + "version": "0.0.0", + "description": "Import NMEA files into Furkot.", + "author": { + "name": "Damian Krzeminski", + "email": "pirxpilot@furkot.com", + "url": "https://pirxpilot.me" + }, + "repository": "furkot/import-nmea", + "license": "MIT", + "keywords": [ + "import-nmea", + "nmea", + "furkot" + ], + "dependencies": {}, + "devDependencies": { + "@pirxpilot/jshint": "^3.0.1" + }, + "scripts": { + "test": "make check" + }, + "files": [ + "index.js", + "lib" + ] +} diff --git a/test/import-nmea.js b/test/import-nmea.js new file mode 100644 index 0000000..55c5900 --- /dev/null +++ b/test/import-nmea.js @@ -0,0 +1,8 @@ +const test = require('node:test'); +const assert = require('node:assert/strict'); +const importNmea = require('../'); + +test.todo('import-nmea must have at least one test', function () { + importNmea(); + assert.ok(true, 'Need to write tests.'); +});