-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 631a26b
Showing
42 changed files
with
10,987 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
node_modules | ||
dist | ||
coverage |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
.pnpm-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/ | ||
|
||
# Snowpack dependency directory (https://snowpack.dev/) | ||
web_modules/ | ||
|
||
# TypeScript cache | ||
*.tsbuildinfo | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# Microbundle cache | ||
.rpt2_cache/ | ||
.rts2_cache_cjs/ | ||
.rts2_cache_es/ | ||
.rts2_cache_umd/ | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
*.tgz | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# dotenv environment variables file | ||
.env | ||
.env.test | ||
.env.production | ||
|
||
# parcel-bundler cache (https://parceljs.org/) | ||
.cache | ||
.parcel-cache | ||
|
||
# Next.js build output | ||
.next | ||
out | ||
|
||
# Nuxt.js build / generate output | ||
.nuxt | ||
dist | ||
|
||
# Gatsby files | ||
.cache/ | ||
# Comment in the public line in if your project uses Gatsby and not Next.js | ||
# https://nextjs.org/blog/next-9-1#public-directory-support | ||
# public | ||
|
||
# vuepress build output | ||
.vuepress/dist | ||
|
||
# Serverless directories | ||
.serverless/ | ||
|
||
# FuseBox cache | ||
.fusebox/ | ||
|
||
# DynamoDB Local files | ||
.dynamodb/ | ||
|
||
# TernJS port file | ||
.tern-port | ||
|
||
# Stores VSCode versions used for testing VSCode extensions | ||
.vscode-test | ||
|
||
# yarn v2 | ||
.yarn/cache | ||
.yarn/unplugged | ||
.yarn/build-state.yml | ||
.yarn/install-state.gz | ||
.pnp.* | ||
|
||
.vscode/* | ||
!.vscode/settings.json | ||
!.vscode/tasks.json | ||
!.vscode/launch.json | ||
!.vscode/extensions.json | ||
*.code-workspace | ||
|
||
# Local History for Visual Studio Code | ||
.history/ | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"extends": "@istanbuljs/nyc-config-typescript" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"$schema": "https://json.schemastore.org/prettierrc", | ||
"arrowParens": "always", | ||
"bracketSpacing": true, | ||
"tabWidth": 4, | ||
"useTabs": true, | ||
"endOfLine": "auto", | ||
"quoteProps": "consistent", | ||
"singleQuote": true, | ||
"printWidth": 70 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
{ | ||
// Use IntelliSense to learn about possible attributes. | ||
// Hover to view descriptions of existing attributes. | ||
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 | ||
"version": "0.2.0", | ||
"configurations": [ | ||
{ | ||
"type": "firefox", | ||
"request": "launch", | ||
"name": "Firefox w/ parcel", | ||
"url": "http://localhost:1234", | ||
"webRoot": "${workspaceFolder}", | ||
"breakOnLoad": true, | ||
"sourceMapPathOverrides": { | ||
"../*": "${webRoot}/*" | ||
} | ||
} | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"typescript.tsdk": "node_modules\\typescript\\lib", | ||
"svg.preview.background": "transparent" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 Brian Crotty | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,109 @@ | ||
# squeaker | ||
<!-- PROJECT LOGO --> | ||
<img src="https://i.imgur.com/HYEN9DZ.png" alt="logo" width="200"/> | ||
|
||
<!-- Shields --> | ||
![npm](https://img.shields.io/npm/l/squeaker.svg) | ||
![size-badge](https://img.badgesize.io/https:/unpkg.com/squeaker/dist/index.modern.js?compression=brotli) | ||
![Types](https://badgen.net/npm/types/squeaker) | ||
|
||
</div> | ||
|
||
--- | ||
|
||
<p align="center"> A tiny (but advanced) simplex noise module | ||
</p> | ||
|
||
## π Table of Contents | ||
|
||
- [squeaker](#squeaker) | ||
- [π Table of Contents](#-table-of-contents) | ||
- [π§ About](#-about) | ||
- [Install](#install) | ||
- [Package Manager](#package-manager) | ||
- [CDN](#cdn) | ||
- [π§ Running the tests](#-running-the-tests) | ||
- [π Usage](#-usage) | ||
- [Example](#example) | ||
- [π License](#-license) | ||
- [βοΈ Authors](#οΈ-authors) | ||
- [π¨ Similar Tools](#-similar-tools) | ||
|
||
## π§ About | ||
|
||
Important but basic info | ||
|
||
## Install | ||
|
||
### Package Manager | ||
|
||
#### NPM <!-- omit in TOC --> | ||
|
||
```sh | ||
npm i squeaker | ||
``` | ||
|
||
#### PNPM <!-- omit in TOC --> | ||
|
||
```sh | ||
pnpm add squeaker | ||
``` | ||
|
||
#### Yarn <!-- omit in TOC --> | ||
|
||
```sh | ||
yarn add squeaker | ||
``` | ||
|
||
### CDN | ||
|
||
#### Skypack <!-- omit in TOC --> | ||
|
||
For Web and Deno, no install is required! Just put this line at the top of your file: | ||
|
||
```typescript | ||
import squeaker from 'https://cdn.skypack.dev/squeaker'; | ||
``` | ||
|
||
If you want type support with skypack, follow the directions [here]('https://docs.skypack.dev/skypack-cdn/code/javascript#using-skypack-urls-in-typescript') | ||
|
||
#### UNPKG <!-- omit in TOC --> | ||
|
||
```html | ||
<script src="https://unpkg.com/squeaker"></script> | ||
``` | ||
|
||
And use it like you would any other package from UNPKG | ||
|
||
|
||
## π§ Running the tests | ||
|
||
The basic set of tests are in the test script, the coverage script, and the report script. Just run those using your perferred package manager (npm, yarn, pnpm, etc.) to make sure nothing has broken. | ||
|
||
## π Usage | ||
|
||
Here's the great part: thanks to [microbundle](https://github.com/developit/microbundle), this package supports CJS, UMD, and ESM formats. | ||
That means that wherever and however you use this package β in browser or node, with import or require β you *should* be set, no configuration required. | ||
<!-- TODO --> | ||
|
||
## Example | ||
<!-- TODO --> | ||
```code | ||
put content here | ||
``` | ||
|
||
<!-- LICENSE --> | ||
## π License | ||
|
||
Distributed under the MIT License. See `LICENSE` for more information. | ||
|
||
## βοΈ Authors | ||
|
||
Find me [@illumincrotty](https://github.com/illumincrotty) on github or [@illumincrotty](https://twitter.com/illumincrotty) on twitter | ||
|
||
## π¨ Similar Tools | ||
If this tool isn't working for you, try one of these: | ||
<!-- TODO --> | ||
- [0]("_blank") | ||
- [1]("_blank") | ||
- [2]("_blank") |
Oops, something went wrong.