Skip to content

Commit 051d43b

Browse files
jamesdbrockjamesdbrock
committed
Run contrib-updater
1 parent 0a80132 commit 051d43b

File tree

11 files changed

+194
-23
lines changed

11 files changed

+194
-23
lines changed

‎.editorconfig

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# https://editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

‎.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Bug report
3+
about: Report an issue
4+
title: ""
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
**Describe the bug**
10+
A clear and concise description of the bug.
11+
12+
**To Reproduce**
13+
A minimal code example (preferably a runnable example on [Try PureScript](https://try.purescript.org)!) or steps to reproduce the issue.
14+
15+
**Expected behavior**
16+
A clear and concise description of what you expected to happen.
17+
18+
**Additional context**
19+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/change-request.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Change request
3+
about: Propose an improvement to this library
4+
title: ""
5+
labels: ""
6+
assignees: ""
7+
---
8+
9+
**Is your change request related to a problem? Please describe.**
10+
A clear and concise description of the problem.
11+
12+
Examples:
13+
14+
- It's frustrating to have to [...]
15+
- I was looking for a function to [...]
16+
17+
**Describe the solution you'd like**
18+
A clear and concise description of what a good solution to you looks like, including any solutions you've already considered.
19+
20+
**Additional context**
21+
Add any other context about the change request here.

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: PureScript Discourse
4+
url: https://discourse.purescript.org/
5+
about: Ask and answer questions here.
6+
- name: Functional Programming Slack
7+
url: https://functionalprogramming.slack.com
8+
about: For casual chat and questions (use https://fpchat-invite.herokuapp.com to join).

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
**Description of the change**
2+
Clearly and concisely describe the purpose of the pull request. If this PR relates to an existing issue or change proposal, please link to it. Include any other background context that would help reviewers understand the motivation for this PR.
3+
4+
---
5+
6+
**Checklist:**
7+
8+
- [ ] Added the change to the changelog's "Unreleased" section with a link to this PR and your username
9+
- [ ] Linked any existing issues or proposals that this pull request should close
10+
- [ ] Updated or added relevant documentation in the README and/or documentation directory
11+
- [ ] Added a test for the contribution (if applicable)

‎.github/workflows/ci.yml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
16+
- name: Set up a PureScript toolchain
17+
uses: purescript-contrib/setup-purescript@main
18+
19+
- name: Cache PureScript dependencies
20+
uses: actions/cache@v2
21+
with:
22+
key: ${{ runner.os }}-spago-${{ hashFiles('**/*.dhall') }}
23+
path: |
24+
.spago
25+
output
26+
27+
- name: Install dependencies
28+
run: spago install
29+
30+
- name: Build source
31+
run: spago build --no-install --purs-args '--censor-lib --strict'
32+
33+
- name: Run tests
34+
run: spago test --no-install

‎.gitignore

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
*~
2-
output/
3-
bower_components/
4-
node_modules/
5-
.psci
6-
.psci_modules/
7-
yarn-error.log
8-
yarn.lock
9-
generated-docs/
10-
.spago/
11-
.psc-ide-port
1+
.*
2+
!.gitignore
3+
!.github
4+
!.editorconfig
5+
6+
output
7+
generated-docs
8+
bower_components

‎CHANGELOG.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# v11 2021-06-21
1+
# Changelog
2+
3+
Notable changes to this project are documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
4+
5+
## v11.0.0 [Unreleased]
26

37
Jorge Acereda has graciously donated this package to __purescript-contrib__.
48
For version 11, we have refactored this library so that it depends only on
@@ -11,12 +15,13 @@ We have removed the dependencies on these non-__purescript-contrib__ packages:
1115
* https://pursuit.purescript.org/packages/purescript-typelevel
1216
* https://pursuit.purescript.org/packages/purescript-quickcheck-combinators
1317

14-
To upgrade to v11, you might need to do a few simple substitutions
18+
In v11.0.0 of this package, we have also upgraded to PureScript v0.14.
19+
20+
### Breaking Changes
21+
22+
To upgrade to v11.0.0, you might need to do a few substitutions
1523
to the type declarations in your own dependent code:
1624

1725
* Replace the type `AProxy` with `Proxy` from the Prelude.
1826
* Remove most of the `Nat` typeclass constraints. https://github.com/purescript-contrib/purescript-arraybuffer/issues/29
1927
* Replace any `BytesPerValue a b` typeclass constraints with `BytesPerType a`.
20-
21-
In v11 of this package, we have also upgraded to PureScript v0.14.
22-

‎CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing to Arraybuffer
2+
3+
Thanks for your interest in contributing to `arraybuffer`! We welcome new contributions regardless of your level of experience or familiarity with PureScript.
4+
5+
Every library in the Contributors organization shares a simple handbook that helps new contributors get started. With that in mind, please [read the short contributing guide on purescript-contrib/governance](https://github.com/purescript-contrib/governance/blob/main/contributing.md) before contributing to this library.

‎README.md

Lines changed: 62 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,77 @@
1-
# purescript-arraybuffer
1+
# arraybuffer
2+
23
[![CI](https://github.com/purescript-contrib/purescript-arraybuffer/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-arraybuffer/actions?query=workflow%3ACI+branch%3Amain)
34
[![Release](https://img.shields.io/github/release/purescript-contrib/purescript-arraybuffer.svg)](https://github.com/purescript-contrib/purescript-arraybuffer/releases)
45
[![Pursuit](https://pursuit.purescript.org/packages/purescript-arraybuffer/badge)](https://pursuit.purescript.org/packages/purescript-arraybuffer)
5-
[![Maintainer: natefaubion](https://img.shields.io/badge/maintainer-jamesdbrock-teal.svg)](https://github.com/jamesdbrock)
6+
[![Maintainer: jacereda](https://img.shields.io/badge/maintainer-jacereda-teal.svg)](https://github.com/jacereda)
7+
[![Maintainer: jamesdbrock](https://img.shields.io/badge/maintainer-jamesdbrock-teal.svg)](https://github.com/jamesdbrock)
8+
9+
10+
Bindings and implementation for mutable JavaScript `ArrayBuffer`s.
611

7-
ArrayBuffer bindings for PureScript.
12+
An `ArrayBuffer` is a built-in JavaScript object for storage of a flat continuous
13+
region of memory.
814

15+
The `Typed` module provides a view into an `ArrayBuffer` for array
16+
access of aligned local-machine-endian types, for in-process flat memory operations.
17+
18+
The `DataView` module provides a view into an `ArrayBuffer` for inter-process
19+
flat memory operations.
20+
21+
* [MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer)
22+
* [ECMA-262](https://tc39.es/ecma262/multipage/structured-data.html#sec-arraybuffer-objects)
923

1024

1125
## Installation
1226

1327
Install `arraybuffer` with [Spago](https://github.com/purescript/spago):
14-
```
15-
spago install purescript-arraybuffer
28+
29+
```sh
30+
spago install arraybuffer
1631
```
1732

1833
## Documentation
1934

20-
Module documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-arraybuffer).
35+
`arraybuffer` documentation is stored in a few places:
36+
37+
1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-arraybuffer).
38+
2. Written documentation is kept in the [docs directory](./docs).
39+
3. Usage examples can be found in [the test suite](./test).
40+
41+
If you get stuck, there are several ways to get help:
42+
43+
- [Open an issue](https://github.com/purescript-contrib/purescript-arraybuffer/issues) if you have encountered a bug or problem.
44+
- [Search or start a thread on the PureScript Discourse](https://discourse.purescript.org) if you have general questions. You can also ask questions in the `#purescript` and `#purescript-beginners` channels on the [Functional Programming Slack](https://functionalprogramming.slack.com) ([invite link](https://fpchat-invite.herokuapp.com/)).
45+
46+
## Contributing
47+
48+
You can contribute to `arraybuffer` in several ways:
49+
50+
1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-arraybuffer/issues). We'll do our best to work with you to resolve or answer it.
51+
52+
2. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions.
53+
54+
3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the [PureScript Discourse](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed.
55+
56+
## Other packages
57+
58+
These are some other packages which provide more `ArrayBuffer` features.
59+
60+
### Reading and Writing
61+
62+
* [__arraybuffer-class__](https://pursuit.purescript.org/packages/purescript-arraybuffer-class)
63+
* [__dynamic-buffers__](https://pursuit.purescript.org/packages/purescript-dynamic-buffers)
64+
* [__parsing-dataview__](https://pursuit.purescript.org/packages/purescript-parsing-dataview)
65+
* [__arraybuffer-builder__](https://pursuit.purescript.org/packages/purescript-arraybuffer-builder)
66+
67+
### Node.js
68+
69+
* [__node-buffer__](https://pursuit.purescript.org/packages/purescript-node-buffer)
70+
71+
### UTF
72+
73+
* [__text-encoding__](https://pursuit.purescript.org/packages/purescript-text-encoding)
74+
75+
### Base64
2176

22-
See https://github.com/AlexaDeWit/purescript-arraybuffer-codecs if you need text/base64 encoding/decoding functions.
77+
* [__base64-codec__](https://pursuit.purescript.org/packages/purescript-base64-codec)

‎docs/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Arraybuffer Documentation
2+
3+
This directory contains documentation for `arraybuffer`. If you are interested in contributing new documentation, please read the [contributor guidelines](../CONTRIBUTING.md) and [What Nobody Tells You About Documentation](https://documentation.divio.com) for help getting started.

0 commit comments

Comments
 (0)