{"id":16247099,"url":"https://github.com/dotnetcarpenter/sanctuary-adt-matrix","last_synced_at":"2026-01-20T13:08:43.667Z","repository":{"id":66079927,"uuid":"396543909","full_name":"dotnetCarpenter/sanctuary-adt-matrix","owner":"dotnetCarpenter","description":"Matrix that shows which Sanctuary ADT's implements which Type Classes","archived":false,"fork":false,"pushed_at":"2021-08-17T13:41:40.000Z","size":32,"stargazers_count":3,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-15T17:22:49.318Z","etag":null,"topics":["sanctuary"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dotnetCarpenter.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-16T00:13:38.000Z","updated_at":"2021-10-27T03:20:02.000Z","dependencies_parsed_at":"2023-06-26T03:01:08.239Z","dependency_job_id":null,"html_url":"https://github.com/dotnetCarpenter/sanctuary-adt-matrix","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnetCarpenter%2Fsanctuary-adt-matrix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnetCarpenter%2Fsanctuary-adt-matrix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnetCarpenter%2Fsanctuary-adt-matrix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dotnetCarpenter%2Fsanctuary-adt-matrix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dotnetCarpenter","download_url":"https://codeload.github.com/dotnetCarpenter/sanctuary-adt-matrix/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247725212,"owners_count":20985664,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["sanctuary"],"created_at":"2024-10-10T14:35:51.763Z","updated_at":"2026-01-20T13:08:43.627Z","avatar_url":"https://github.com/dotnetCarpenter.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sanctuary ADT Matrix\n\n[![npm](https://img.shields.io/npm/v/sanctuary-adt-matrix.svg)](https://www.npmjs.com/package/sanctuary-adt-matrix)\n\n\nUsage:\n\n```\n$ npx sanctuary-adt-matrix\n```\n\n|  Type Class   | Pair | Maybe | Either | Future |\n| ------------- | ---- | ----- | ------ | ------ |\n| Setoid        | ✅   | ✅    | ✅     | ❌    |\n| Ord           | ✅   | ✅    | ✅     | ❌    |\n| Semigroupoid  | ✅   | ❌    | ❌     | ❌    |\n| Category      | ❌   | ❌    | ❌     | ❌    |\n| Semigroup     | ✅   | ✅    | ✅     | ❌    |\n| Monoid        | ❌   | ✅    | ❌     | ❌    |\n| Group         | ❌   | ❌    | ❌     | ❌    |\n| Filterable    | ❌   | ✅    | ❌     | ❌    |\n| Functor       | ✅   | ✅    | ✅     | ✅    |\n| Bifunctor     | ✅   | ❌    | ✅     | ✅    |\n| Profunctor    | ❌   | ❌    | ❌     | ❌    |\n| Apply         | ✅   | ✅    | ✅     | ✅    |\n| Applicative   | ❌   | ✅    | ✅     | ✅    |\n| Chain         | ✅   | ✅    | ✅     | ✅    |\n| ChainRec      | ❌   | ✅    | ✅     | ✅    |\n| Monad         | ❌   | ✅    | ✅     | ✅    |\n| Alt           | ❌   | ✅    | ✅     | ✅    |\n| Plus          | ❌   | ✅    | ❌     | ❌    |\n| Alternative   | ❌   | ✅    | ❌     | ❌    |\n| Foldable      | ✅   | ✅    | ✅     | ❌    |\n| Traversable   | ✅   | ✅    | ✅     | ❌    |\n| Extend        | ✅   | ✅    | ✅     | ❌    |\n| Comonad       | ✅   | ❌    | ❌     | ❌    |\n| Contravariant | ❌   | ❌    | ❌     | ❌    |\n\n\n## Using the matrix API\n\nTest [Sanctuary's](https://sanctuary.js.org/) Algebraic Data Types (ADT) for [Type Class](https://github.com/sanctuary-js/sanctuary-type-classes/tree/v12.1.0#sanctuary-type-classes) support.\n\n\u003e The API is **unstable** and will probably change between minor versions.\n\n```js\nconst { adts, typeClassTests } = require ('sanctuary-adt-matrix');\n\n// adts :: Array (Array (String Adt))\n[\n  ['Pair'  , Adt],\n  ['Maybe' , Adt],\n  ['Either', Adt],\n  ['Future', Adt]\n]\n\n// typeClassTests :: Array (Array (String Adt) -\u003e Array (String))\ntypeClassTests [0] (adts) // -\u003e [ 'Setoid', '✅', '✅', '✅', '❌' ]\n```\n\n## Adding an ADT\n\nCurrently (1.0.1), you need to change two places. To add a new ADT, you need to edit _index.js_,\nrequire the new ADT and add it to the `adts` array.\n\n```js\nconst adts = [\n  ['Pair'  , S.Pair ('') ('')],\n  ['Maybe' , S.Just ('')],\n  ['Either', S.Right ('')],\n  ['Future', Future (reject =\u003e resolve =\u003e () =\u003e {})]\n];\n```\n_The tuple is `[name:String, instance:ADT]`._\n\nThen you need to set padding in _view/markdown.js_ in the `view` function.\n\n```js\n${S.joinWith ('\\n')\n             (S.map (r =\u003e `| ${r} |`)\n                    (row ([13, 3, 4, 5, 5]) (S.map (test =\u003e test (adts))\n                                                   (typeClassTests))))}\n```\n_The padding is `[13, 3, 4, 5, 5]`._\n\n```js\n[\n  13, // = longest Type Class word\n  3,  // = padding for Pair column\n  4,  // = padding for Maybe column\n  5,  // = padding for Either column\n  5,  // = padding for Future column\n      // add padding for your ADT column - usually number of characters minus 1\n]\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotnetcarpenter%2Fsanctuary-adt-matrix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdotnetcarpenter%2Fsanctuary-adt-matrix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdotnetcarpenter%2Fsanctuary-adt-matrix/lists"}