Initial commit

.config

@@ -0,0 +1,6 @@
+author-name = Aldwin Vlasblom
+repo-owner = fluture-js
+repo-name = fluture-project
+source-files = index.js
+module-type = esm
+opening-delimiter = ```js

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintrc.json

@@ -0,0 +1,12 @@
+{
+  "root": true,
+  "extends": ["./node_modules/sanctuary-style/eslint-es3.json"],
+  "parserOptions": {"sourceType": "module"},
+  "env": {"shared-node-browser": true, "es6": true},
+  "overrides": [
+    {
+      "files": ["README.md"],
+      "rules": {"no-undef": ["off"]}
+    }
+  ]
+}

.github/PULL_REQUEST_TEMPLATE/initial-pr.md

@@ -0,0 +1,39 @@
+---
+name: Initial pull request
+about: When you've just generated this repository and you want to get to work.
+---
+
+# Everything
+
+This pull request adds everything the project needs to be at its first release.
+
+# TODO
+
+- [ ] Update `author-name` and `repo-owner` in `.config` and
+      ensure the tests pass.
+
+- [ ] Name the project:
+    - Change `repo-name` in `.config` and ensure the tests pass.
+    - Change the header of the documentation in `index.js`.
+    - Change the module name in `rollup.config.js`.
+
+- [ ] Describe the project:
+    - Change `description` in `package.json`.
+    - Update the GitHub repo description.
+    - Add the description to the documentation in `index.js`.
+    - Add additional `tags` in `package.json`.
+
+- [ ] If this is a node-only module, remove browser support:
+    - Change `umd` to `cjs` in `rollup.config.js` and remove `output.name`.
+    - Change `eslint-es3` to `eslint-es6` in `.eslintrc.json`.
+    - Change `shared-node-browser` to `node` in `.eslintrc.json`.
+
+- [ ] Set up integration with Codecov:
+    - Find the Codecov token in the Codecov settings for your new repository:
+      https://codecov.io/gh/{owner}/{repository}/settings.
+    - Save it as `CODECOV_TOKEN` in the secrets for your new repository:
+      https://github.com/{owner}/{repository}/settings/secrets.
+
+- [ ] Remove the `initial-pr.md` pull-request template.
+
+- [ ] Write the code.

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    name: Automated Tests
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Code
+      uses: actions/checkout@v1
+    - name: Install NodeJS
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12.x
+    - name: Install Dependencies
+      run: npm install
+    - name: Execute Tests
+      run: npm test
+    - name: Upload Coverage Report
+      run: npm run codecov
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -0,0 +1,3 @@
+/coverage/
+/index.cjs
+/node_modules/

.npmrc

@@ -0,0 +1 @@
+package-lock=false

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contribution Guideline
+
+## Making a contribution
+
+1. Fork the repo if you do not have write access
+1. Clone the remote (fork) from GitHub
+1. Create a branch named `<yourgithubusername>/<yourfeature>`
+1. Make one or more atomic commits
+1. Make sure the tests pass locally
+1. Create a pull request on GitHub
+
+## Publishing a new version
+
+1. Make sure you have write access to the module on npm
+1. Make sure you have write access to the master branch on GitHub
+1. Checkout `master` and make sure it's up to date with the remote
+1. Run `npm run release <level>`, where `<level>` can be any of: 'major',
+   'minor', 'patch', 'premajor', 'preminor', 'prepatch', or 'prerelease'.

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2019 Aldwin Vlasblom
+
+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.

README.md

@@ -0,0 +1,4 @@
+# Under Construction
+
+This project is still under construction. If all went well, you should be
+able to learn about it in the [initial pull request](./pull/1).

index.js

@@ -0,0 +1 @@
+//. # Fluture Project

package.json

@@ -0,0 +1,39 @@
+{
+  "name": "fluture-project",
+  "version": "0.0.0",
+  "description": "Hopefully something related to Fluture",
+  "tags": ["fluture"],
+  "type": "module",
+  "main": "index.cjs",
+  "module": "index.js",
+  "scripts": {
+    "build": "rollup -c rollup.config.js",
+    "codecov": "codecov",
+    "doctest": "sanctuary-doctest",
+    "lint": "sanctuary-lint",
+    "release": "sanctuary-release",
+    "test": "npm run lint && sanctuary-test && npm run doctest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/fluture-js/fluture-project.git"
+  },
+  "files": [
+    "/index.cjs",
+    "/index.js",
+    "/LICENSE",
+    "/package.json",
+    "/README.md"
+  ],
+  "author": "Aldwin Vlasblom <[email protected]> (https://github.com/Avaq)",
+  "license": "MIT",
+  "dependencies": {},
+  "peerDependencies": {},
+  "devDependencies": {
+    "c8": "^7.1.0",
+    "codecov": "^3.2.0",
+    "oletus": "^3.0.0",
+    "rollup": "^2.0.0",
+    "sanctuary-scripts": "^4.0.0"
+  }
+}

rollup.config.js

@@ -0,0 +1,9 @@
+export default {
+  input: 'index.js',
+  output: {
+    format: 'umd',
+    file: 'index.cjs',
+    name: 'flutureProject',
+    interop: false
+  }
+};

scripts/prepublish

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+set -eufo pipefail
+
+echo "Publishing as $(npm whoami)."
+
+if ! npm outdated --long; then
+  read -rp "Continue? [y/N] " choice
+  if [[ "${choice-n}" != 'y' ]]; then
+    echo 'Package distribution aborted.'
+    exit 2
+  fi
+fi
+
+npm run build
+
+sanctuary-prepublish "$@"

scripts/test

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -eufo pipefail
+
+# shellcheck source=../node_modules/sanctuary-scripts/functions
+source "${BASH_SOURCE%/*}/../node_modules/sanctuary-scripts/functions"
+
+branches="$(get min-branch-coverage)"
+
+c8 --check-coverage \
+   --branches "$branches" \
+   --reporter lcov \
+   node --experimental-modules \
+        --no-warnings \
+        ./node_modules/.bin/oletus

test/index.js

@@ -0,0 +1 @@
+import '../index.js';