Skip to content

Update according to Contributors library guidelines #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# https://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

[*.md]
trim_trailing_whitespace = false
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Bug report
about: Report an issue
title: ""
labels: bug
assignees: ""
---

**Describe the bug**
A clear and concise description of the bug.

**To Reproduce**
A minimal code example (preferably a runnable example on [Try PureScript](https://try.purescript.org)!) or steps to reproduce the issue.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Additional context**
Add any other context about the problem here.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/change-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Change request
about: Propose an improvement to this library
title: ""
labels: ""
assignees: ""
---

**Is your change request related to a problem? Please describe.**
A clear and concise description of the problem.

Examples:

- It's frustrating to have to [...]
- I was looking for a function to [...]

**Describe the solution you'd like**
A clear and concise description of what a good solution to you looks like, including any solutions you've already considered.

**Additional context**
Add any other context about the change request here.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: PureScript Discourse
url: https://discourse.purescript.org/
about: Ask and answer questions here.
- name: Functional Programming Slack
url: https://functionalprogramming.slack.com
about: For casual chat and questions (use https://fpchat-invite.herokuapp.com to join).
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
**Description of the change**
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.

---

**Checklist:**

- [ ] Added the change to the changelog's "Unreleased" section with a link to this PR and your username
- [ ] Linked any existing issues or proposals that this pull request should close
- [ ] Updated or added relevant documentation in the README and/or documentation directory
- [ ] Added a test for the contribution (if applicable)
34 changes: 34 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: CI

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
build:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2

- name: Set up a PureScript toolchain
uses: purescript-contrib/setup-purescript@main

- name: Cache PureScript dependencies
uses: actions/cache@v2
with:
key: ${{ runner.os }}-spago-${{ hashFiles('**/*.dhall') }}
path: |
.spago
output

- name: Install dependencies
run: spago install

- name: Build source
run: spago build --no-install

- name: Run tests
run: spago test --no-install
19 changes: 5 additions & 14 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,17 +1,8 @@
/.*
!/.gitignore
!/.github
!/.travis.yml
.*
!.gitignore
!.github
!.editorconfig

# Dependencies
bower_components
node_modules

# Generated files
output
dce-output
generated-docs

# Lockfiles
package-lock.json
*.lock
bower_components
23 changes: 0 additions & 23 deletions .travis.yml

This file was deleted.

81 changes: 81 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Changelog

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).

## [Unreleased]

Breaking changes (😱!!!):

New features:

Bugfixes:

Other improvements:

## [v7.0.1](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v7.0.1) - 2019-06-04

- Updated for PureScript 0.13 compatibility

## [v7.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v7.0.0) - 2019-03-04

- Updated dependencies

## [v6.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v6.0.0) - 2018-06-28

- Updates for PS@0.12 @therealnicksaunders

## [v5.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v5.0.0) - 2018-03-20

- Remove `Sandboxed` slot from `Pathy` type.
- Add better way of Sandboxing.
- Use `NonEmptyString` for segment names.
- Make runtime representation of Pathy simpler.
- And bunch more, see #33 (@safareli, @garyb)

## [v4.1.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v4.1.0) - 2017-12-21

- Add Gen module - @safareli #31

## [v4.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v4.0.0) - 2017-04-04

- Updated for PureScript 0.11
- Removed deprecated `Data.Generic` instances.

## [v3.0.2](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v3.0.2) - 2016-12-21

- Fixed shadowed name warning
- Fixed license identifier for Pursuit publishing

## [v3.0.1](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v3.0.1) - 2016-11-14

- Fixed `Ord` instance

## [v3.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v3.0.0) - 2016-10-28

- Updated dependencies for PureScript 0.10

## [v2.0.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v2.0.0) - 2016-07-28

- The `Escaper` is no longer ignored when printing paths
- Directories are consistently on the left and files consistently on the right in `Either`s and function arguments now

## [v0.3.3](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v0.3.3) - 2016-04-21

- Fix the exports for v0.3.2

## [v0.3.2](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v0.3.2) - 2016-04-21

- Added synonyms for where a path is either a directory or file.
- Added `pathName` to extract the name of a directory or file.

## [v0.3.1](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v0.3.1) - 2016-01-21

- Fixed various warnings raised by psc 0.7.6.1

## [v0.2.1](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v0.2.1) - 2015-08-14

- Functionally identical to v0.2.0, this update is to allow publishing on http://pursuit.purescript.org/

## [v0.1.0](https://github.com/purescript-contrib/purescript-pathy/releases/tag/v0.1.0) - 2015-04-29

- Initial release
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Contributing to Pathy

Thanks for your interest in contributing to `pathy`! We welcome new contributions regardless of your level of experience or familiarity with PureScript.

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.
41 changes: 30 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
# purescript-pathy
# Pathy

[![Latest release](http://img.shields.io/github/release/slamdata/purescript-pathy.svg)](https://github.com/slamdata/purescript-pathy/releases)
[![Build status](https://travis-ci.org/slamdata/purescript-pathy.svg?branch=master)](https://travis-ci.org/slamdata/purescript-pathy)
[![CI](https://github.com/purescript-contrib/purescript-pathy/workflows/CI/badge.svg?branch=main)](https://github.com/purescript-contrib/purescript-pathy/actions?query=workflow%3ACI+branch%3Amain)
[![Release](https://img.shields.io/github/release/purescript-contrib/purescript-pathy.svg)](https://github.com/purescript-contrib/purescript-pathy/releases)
[![Pursuit](https://pursuit.purescript.org/packages/purescript-pathy/badge)](https://pursuit.purescript.org/packages/purescript-pathy)
[![Maintainer: garyb](https://img.shields.io/badge/maintainer-garyb-teal.svg)](https://github.com/garyb)
[![Maintainer: thomashoneyman](https://img.shields.io/badge/maintainer-thomashoneyman-teal.svg)](https://github.com/thomashoneyman)

A type-safe abstraction for platform-independent file system paths.

## Installation

```bash
bower install purescript-pathy
```
Install `pathy` with [Spago](https://github.com/purescript/spago):

```purescript
import Pathy
```sh
spago install pathy
```

## Introduction
## Quick start

Applications often have to refer to file system paths in a platform-independent way.

Expand Down Expand Up @@ -122,6 +123,24 @@ There are many other functions available to you for renaming files, renaming dir

These are all documented [on Pursuit](http://pursuit.purescript.org/packages/purescript-pathy), and you can find [test usages](/test/Main.purs) for most of them.

# API Docs
## Documentation

`pathy` documentation is stored in a few places:

1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-pathy).
2. Usage examples can be found in [the test suite](./test).

If you get stuck, there are several ways to get help:

- [Open an issue](https://github.com/purescript-contrib/purescript-pathy/issues) if you have encountered a bug or problem.
- [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/)).

## Contributing

You can contribute to `pathy` in several ways:

1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-pathy/issues). We'll do our best to work with you to resolve or answer it.

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.

Documentation for all functions and types is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-pathy).
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.
13 changes: 0 additions & 13 deletions package.json

This file was deleted.

4 changes: 4 additions & 0 deletions packages.dhall
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
let upstream =
https://github.com/purescript/package-sets/releases/download/psc-0.13.8-20200922/packages.dhall sha256:5edc9af74593eab8834d7e324e5868a3d258bbab75c5531d2eb770d4324a2900

in upstream
18 changes: 18 additions & 0 deletions spago.dhall
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{ name = "pathy"
, dependencies =
[ "console"
, "effect"
, "exceptions"
, "lists"
, "partial"
, "profunctor"
, "psci-support"
, "quickcheck"
, "strings"
, "transformers"
, "typelevel-prelude"
, "unsafe-coerce"
]
, packages = ./packages.dhall
, sources = [ "src/**/*.purs", "test/**/*.purs" ]
}
2 changes: 1 addition & 1 deletion src/Pathy/Printer.purs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import Data.String.NonEmpty.CodeUnits (cons, singleton) as NES
import Partial.Unsafe (unsafePartial)
import Pathy.Name (Name)
import Pathy.Path (Path, foldPath, (</>))
import Pathy.Phantom (class IsDirOrFile, class IsRelOrAbs, Dir, Rel, foldDirOrFile, foldRelOrAbs, kind DirOrFile, kind RelOrAbs)
import Pathy.Phantom (class IsDirOrFile, class IsRelOrAbs, Dir, Rel, foldDirOrFile, foldRelOrAbs)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just now getting to this.

Could you explain why the two kinds here were removed? Is this because you're also updating this lib for the v0.14.0-rc2 release?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's just because they aren't used in this code, and so this produced a compiler warning. Nothing to do with 0.14!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think kinds weren't considered in the import usage checking previously, which is why it became a warning now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha. Thanks for clarifying.

import Pathy.Sandboxed (SandboxedPath, sandboxRoot, unsandbox)
import Prim.TypeError (class Warn, Text)

Expand Down