Initial commit

.dependabot/config.yml

@@ -0,0 +1,12 @@
+version: 1
+update_configs:
+  - package_manager: "javascript"
+    update_schedule: "daily"
+    directory: "."
+    default_assignees:
+      # update to your username :party:
+      - "HugoDF"
+    automerged_updates:
+      - match:
+          dependency_type: "all"
+          update_type: "all"

.editorconfig

@@ -0,0 +1,18 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+# The JSON files contain newlines inconsistently
+[*.json]
+insert_final_newline = ignore
+
+[*.md]
+trim_trailing_whitespace = false
+

.github/workflows/nodejs.yml

@@ -0,0 +1,28 @@
+name: Build & test
+
+on: [push]
+
+jobs:
+  lint_build_test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x]
+
+    env:
+      CI: true
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: yarn install
+      run: yarn
+    - name: lint
+      run: yarn lint
+    - name: build & test
+      run: yarn build && yarn test

.gitignore

@@ -0,0 +1,92 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+dist
+.rts2_cache_*
+schema.json
+_gen

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+Copyright (c) 2019-2020 Hugo Di Francesco
+
+
+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,54 @@
+![Build](https://github.com/HugoDF/buttondown/workflows/Build%20&%20test/badge.svg)
+
+microbundle-ts-pkg: A TypeScript npm package skeleton/starter project with microbundle, AVA and XO
+
+Comes with:
+
+- [SAMPLE_README.md](./SAMPLE_README.md) and [USE_CASES.md](./USE_CASES.md) for documentation.
+- AVA for testing (see [./tests](./tests))
+- XO for linting/formatting
+- microbundle for compiling TypeScript to UMD, ESM, CJS
+
+## Requirements
+
+- Node 10
+- Yarn 1.x or npm
+
+## Setup
+
+1. Clone the repository
+2. Run `yarn` or `npm install` installs all required dependencies.
+3. Run `yarn build` to build from TypeScript to common JavaScript distribution formats.
+4. Run `yarn test` to run all tests :D.
+
+## npm scripts
+
+> Equivalent `npm run <script>` should also work
+
+- `yarn test` run tests against **built output** with [ava](https://github.com/avajs/ava). **Important**: runs against build output so run `yarn build` beforehand.
+- `yarn build` run build from TypeScript to UMD, CJS, ESM with [microbundle](https://github.com/developit/microbundle)
+- `yarn watch` runs build in watch mode with [microbundle](https://github.com/developit/microbundle)
+- `yarn lint` will lint all of the files with [xo](https://github.com/xojs/xo)
+- `yarn format` will run lint with `--fix` option on all the examples files (and tests).
+- `yarn release`, run clean, production build and release with `np`.
+
+# About
+
+This package is maintained by Hugo from [Code with Hugo](https://codewithhugo.com) and [Alpine.js Weekly](https://alpinejs.codewithhugo.com/newsletter).
+
+## Acknowledgments
+
+
+Special thanks to:
+
+- The developers behind
+  - [ava](https://avajs.dev)
+  - [esm](https://github.com/standard-things/esm#readme)
+  - [microbundle](https://github.com/developit/microbundle#readme)
+  - [np](https://github.com/sindresorhus/np#readme)
+  - [xo](https://github.com/xojs/xo#readme)
+
+# LICENSE
+
+Code is licensed under the [MIT License](./LICENSE).
+

SAMPLE_README.md

@@ -0,0 +1,124 @@
+![Build](https://github.com/HugoDF/buttondown/workflows/Build%20&%20test/badge.svg)
+
+DESCRIBE THE LIBRARY
+
+LINK TO OTHER RESOURCES
+
+**This library allows you to quickly and easily do @todo via Node.js.**
+
+This project is not officially affiliated with @todo, it's maintained by community members. For any feedback, questions or issues, please create [issues](https://github.com/HugoDF/microbundle-ts-pkg/issues) and [pull requests](https://github.com/HugoDF/microbundle-ts-pkg/blob/master/README.md#contributing) or merely upvote or comment on existing issues or pull requests.
+
+# Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Installation](#installation)
+  - [Prerequisites](#prerequisites)
+  - [Obtain an API Key](#obtain-an-api-key)
+  - [Setup Environment Variables](#setup-environment-variables)
+  - [Install Package](#install-package)
+- [Quick Start, Create a Draft](#quick-start-create-a-draft)
+- [Roadmap](#roadmap)
+- [Contributing](#contributing)
+  - [Requirements](#requirements)
+  - [Setup](#setup)
+  - [npm scripts](#npm-scripts)
+- [About](#about)
+  - [Acknowledgments](#acknowledgments)
+- [LICENSE](#license)
+
+# Installation
+
+## Prerequisites
+
+- Node.js version 10 or 12
+<!-- - A Buttondown account, [sign up for free](https://buttondown.email/register?source=buttondown-nodejs) free for your first thousand subscribers or check out [the pricing page](https://buttondown.email/pricing?source=buttondown-nodejs). -->
+
+## Obtain an API Key
+
+Grab your API Key from the [@todo](@todo).
+
+## Setup Environment Variables
+
+Do not hardcode your [API Key](@todo) into your code. Instead, use an environment variable or some other secure means of protecting your API Key. Following is an example of using an environment variable.
+
+Update the development environment with your [@todo](@todo), for example:
+
+<!--
+```bash
+echo "export BUTTONDOWN_API_KEY='YOUR_API_KEY'" > buttondown.env
+echo "buttondown.env" >> .gitignore
+source ./buttondown.env
+```
+-->
+
+## Install Package
+
+The following recommended installation requires [npm](https://npmjs.org/). If you are unfamiliar with npm, see the [npm docs](https://npmjs.org/doc/). Npm comes installed with Node.js since node version 0.8.x, therefore, you likely already have it.
+
+```sh
+npm install --save @todo
+```
+
+You may also use [yarn](https://yarnpkg.com/en/) to install.
+
+```sh
+yarn add @todo
+```
+
+<a name="quick-start"></a>
+# Quick Start, Create a Draft
+
+The following is the minimum needed code to use this library. Use this example, and modify the `to` and `from` variables:
+
+For more complex use cases, please see [USE_CASES.md](./USE_CASES.md).
+
+
+# Roadmap
+
+If you are interested in the future direction of this project, please take a look at the open [issues](https://github.com/HugoDF/microbundle-ts-pkg/issues) and [pull requests](https://github.com/HugoDF/microbundle-ts-pkg/pulls). I would love to hear your feedback!
+
+# Contributing
+
+## Requirements
+
+- Node 10
+- Yarn 1.x or npm
+
+## Setup
+
+1. Clone the repository
+2. Run `yarn` or `npm install` installs all required dependencies.
+3. Run `yarn build` to build from TypeScript to common JavaScript distribution formats.
+4. Run `yarn test` to run all tests :D.
+
+## npm scripts
+
+> Equivalent `npm run <script>` should also work
+
+- `yarn test` run tests against **built output** with [ava](https://github.com/avajs/ava). **Important**: runs against build output so run `yarn build` beforehand.
+- `yarn build` run build from TypeScript to UMD, CJS, ESM with [microbundle](https://github.com/developit/microbundle)
+- `yarn watch` runs build in watch mode with [microbundle](https://github.com/developit/microbundle)
+- `yarn lint` will lint all of the files with [xo](https://github.com/xojs/xo)
+- `yarn format` will run lint with `--fix` option on all the examples files (and tests).
+- `yarn release`, run clean, production build and release with `np`.
+
+# About
+
+This package is maintained by Hugo from [Code with Hugo](https://codewithhugo.com) and [Alpine.js Weekly](https://alpinejs.codewithhugo.com/newsletter).
+
+## Acknowledgments
+
+
+Special thanks to:
+
+- The developers behind
+  - [ava](https://avajs.dev)
+  - [esm](https://github.com/standard-things/esm#readme)
+  - [microbundle](https://github.com/developit/microbundle#readme)
+  - [np](https://github.com/sindresorhus/np#readme)
+  - [xo](https://github.com/xojs/xo#readme)
+
+# LICENSE
+
+Code is licensed under the [MIT License](./LICENSE).
+

USE_CASES.md

@@ -0,0 +1,8 @@
+This documentation provides examples for specific use cases in Node.js. Please [open an issue](https://github.com/HugoDF/microbundle-ts-pkg/issues) or make a pull request for any other use cases you would like us to document here. Thank you!
+
+
+## Table of contents/resource list
+
+## Resource 1
+
+Use cases for the resource