fortepiano 0.1.1 → 0.1.2

package/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+
+All notable changes to this project will be 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).
+
+## [0.1.2](https://github.com/facile-it/fortepiano/compare/v0.1.1...v0.1.2) - 2022-04-29
+
+### Added
+
+- Add `LICENSE.md`.
+- Add `CONTRIBUTING.md`.
+- Add `CHANGELOG.md`.
+
+### Changed
+
+- Relicense as MIT.
+- Update `README.md`.
+
+### Deprecated
+
+- Deprecate `$got` (use `$axios` instead).
+
+## [0.1.1](https://github.com/facile-it/fortepiano/compare/v0.1.0...v0.1.1) - 2022-04-26
+
+### Added
+
+- Support [tree shaking](https://webpack.js.org/guides/tree-shaking/) via top-level imports:
+  ```
+  import { curry } from 'fortepiano/function'
+  // ...instead of `import { curry } from 'fortepiano/lib/function'`
+  ```
+
+### Deprecated
+
+- Discourage imports from `fortepiano/lib/*` as they break tree shaking.
+
+## [0.1.0](https://github.com/facile-it/fortepiano/releases/tag/v0.1.0) - 2022-04-20
+
+### Added
+
+- First public release of `fortepiano`.

package/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing
+
+Any relevant modification to this project should be duly noted in `CHANGELOG.md`. Changelog entries should come along code patches via pull requests.
+
+## Style guide
+
+`fortepiano` modules should mymic `fp-ts` as best as they can regarding scope, naming and structure (see [`fp-ts` code conventions](https://gcanti.github.io/fp-ts/guides/code-conventions.html)). A custom convention should be used instead for imports and exports.
+
+```typescript
+/**
+ * Import whole modules (i.e., values) from package index, and types
+ * from specific modules. "Function" modules are an exception.
+ */
+import { option } from 'fp-ts'
+import { Option } from 'fp-ts/Option'
+import { pipe } from 'fp-ts/function'
+import { curry } from './function'
+
+/**
+ * Use namespace imports for local modules; don't import from index,
+ * it creates circular dependencies. Local modules must be spelled in
+ * camel case to stand out from types, and are prefixed with a `$` to
+ * avoid collisions.
+ */
+import * as $type from './Type'
+// ...instead of `import { $type } from '.'`
+
+/**
+ * Use namespace imports for io-ts and friends, to avoid collisions
+ * and enforce consistency.
+ */
+import * as t from 'io-ts'
+import * as tt from 'io-ts-types'
+import * as nt from 'newtype-ts'
+
+/**
+ * Types must be spelled in Pascal case. Prefix them with a `$` if
+ * they collide with an internal type (e.g., `$Record`).
+ */
+export interface FooBar {}
+
+/**
+ * Export functions directly, and don't forget to export the whole
+ * module as a namespace from index.
+ */
+export const fooBar = () => undefined
+```
+
+### _A Fistful of `$`s_
+
+We're in no way fans of prefixing stuff with `$`, but it's the best way we've found so far to avoid name collisions with internal TypeScript types, `fp-ts` exports, and generic variables.

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Facile.it
+
+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.

package/README.md

@@ -1,4 +1,56 @@
-# fortepiano
+# fortepiano [ˌfɔrteˈpjaːno]
 
-[![main](https://github.com/facile-it/fortepiano/actions/workflows/main.yaml/badge.svg)](https://github.com/facile-it/fortepiano/actions/workflows/main.yaml)
-[![codecov](https://codecov.io/gh/facile-it/fortepiano/branch/master/graph/badge.svg?token=GRJ7ANG8WS)](https://codecov.io/gh/facile-it/fortepiano)
+_Playing actual music over `fp-ts` notes_
+
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/facile-it/fortepiano/main)](https://github.com/facile-it/fortepiano/actions)
+[![Codecov](https://img.shields.io/codecov/c/gh/facile-it/fortepiano)](https://app.codecov.io/gh/facile-it/fortepiano)
+[![GitHub](https://img.shields.io/github/license/facile-it/fortepiano)](LICENSE.md)
+[![npm](https://img.shields.io/npm/v/fortepiano)](https://www.npmjs.com/package/fortepiano)
+
+## Description
+
+`fortepiano` provides a set of common abstractions for functional application development (e.g., `Http`, `Storage`...), while extending [`fp-ts`](https://github.com/gcanti/fp-ts) with useful modules _à la_ [`fp-ts-contrib`](https://github.com/gcanti/fp-ts-contrib).
+
+## Getting Started
+
+`fortepiano` stands on the shoulders of the giant `fp-ts`. As such, a good understanding of its [concepts](https://gcanti.github.io/fp-ts/) is suggested.
+
+### Installation
+
+The package is available via [npm](https://www.npmjs.com/package/fortepiano), and must be installed along with its peer dependencies:
+
+```
+npm install fortepiano fp-ts io-ts io-ts-types
+```
+
+Additional packages are required, shall you want to use specific abstractions:
+
+- [`memcached`](https://www.npmjs.com/package/memcached) and [`@types/memcached`](https://www.npmjs.com/package/@types/memcached) (`cache/Memcached`)
+- [`redis`](https://www.npmjs.com/package/redis) and [`@types/redis`](https://www.npmjs.com/package/@types/redis) (`cache/Redis`)
+- [`axios`](https://www.npmjs.com/package/axios) (`http/Axios`)
+- [`@slynova/flydrive`](https://www.npmjs.com/package/@slynova/flydrive) (`storage/Flydrive`)
+
+### Usage
+
+Import modules (e.g., values) from package index and types from specific modules. "Function" module and abstraction implementations are an exception:
+
+```typescript
+import { $type } from 'fortepiano'
+import { Struct } from 'fortepiano/struct'
+import { curry } from 'fortepiano/function'
+import { $axios } from 'fortepiano/http/Axios'
+```
+
+## Contributing
+
+See the [CONTRIBUTING.md](CONTRIBUTING.md) file for details.
+
+## Authors
+
+- [Davide Caruso](https://github.com/davidecaruso)
+- [Pier Roberto Lucisano](https://github.com/pierroberto)
+- [Alberto Villa](https://github.com/xzhavilla)
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE.md](LICENSE.md) file for details.

package/esm/http/Got.js

@@ -26,6 +26,9 @@ const request = (_got, method, url, options = {}) => $TE.tryCatch(() => _got(url
         body: error.response.body,
     }, `Cannot make HTTP request "${$S.uppercase(method)} ${url}": ${error.message}`))(error);
 }), $E.fromUnknown(Error(`Cannot make HTTP request "${$S.uppercase(method)} ${url}"`)));
+/**
+ * @deprecated Use `$axios` instead
+ */
 export const $got = (_got) => ({
     delete: (url, options) => request(_got, 'delete', url, options),
     get: (url, options) => request(_got, 'get', url, options),

package/http/Got.d.ts

@@ -1,3 +1,6 @@
 import { Got } from 'got';
 import * as $H from '../Http';
+/**
+ * @deprecated Use `$axios` instead
+ */
 export declare const $got: (_got: Got) => $H.Http;

package/lib/http/Got.d.ts

@@ -1,3 +1,6 @@
 import { Got } from 'got';
 import * as $H from '../Http';
+/**
+ * @deprecated Use `$axios` instead
+ */
 export declare const $got: (_got: Got) => $H.Http;

package/lib/http/Got.js

@@ -48,6 +48,9 @@ const request = (_got, method, url, options = {}) => $TE.tryCatch(() => _got(url
         body: error.response.body,
     }, `Cannot make HTTP request "${$S.uppercase(method)} ${url}": ${error.message}`))(error);
 }), $E.fromUnknown(Error(`Cannot make HTTP request "${$S.uppercase(method)} ${url}"`)));
+/**
+ * @deprecated Use `$axios` instead
+ */
 const $got = (_got) => ({
     delete: (url, options) => request(_got, 'delete', url, options),
     get: (url, options) => request(_got, 'get', url, options),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fortepiano",
-  "version": "0.1.1",
-  "description": "",
+  "version": "0.1.2",
+  "description": "Playing actual music over fp-ts notes",
   "main": "./lib/index.js",
   "module": "./esm/index.js",
   "types": "./index.d.ts",
@@ -26,11 +26,17 @@
     "url": "git+https://github.com/facile-it/fortepiano.git"
   },
   "author": "Alberto Villa <villa.alberto@gmail.com>",
-  "license": "ISC",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/facile-it/fortepiano/issues"
   },
   "homepage": "https://github.com/facile-it/fortepiano#readme",
+  "keywords": [
+    "typescript",
+    "functional-programming",
+    "fp-ts",
+    "io-ts"
+  ],
   "devDependencies": {
     "@slynova/flydrive": "^1.0.0",
     "@types/jest": "^26.0.24",