{"id":15879552,"url":"https://github.com/ticky/linguists-field-guide","last_synced_at":"2025-03-16T09:33:39.007Z","repository":{"id":42126900,"uuid":"306456734","full_name":"ticky/linguists-field-guide","owner":"ticky","description":"📖 Field guide for programming languages, based on the knowledge imparted by github-linguist","archived":false,"fork":false,"pushed_at":"2025-02-15T07:40:14.000Z","size":81,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":3,"default_branch":"develop","last_synced_at":"2025-02-27T07:31:11.989Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/ticky.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2020-10-22T20:56:03.000Z","updated_at":"2024-06-14T03:18:45.000Z","dependencies_parsed_at":"2024-04-23T15:58:32.023Z","dependency_job_id":"5e0ab35d-f1df-4f01-a270-6e31154a7754","html_url":"https://github.com/ticky/linguists-field-guide","commit_stats":{"total_commits":35,"total_committers":3,"mean_commits":"11.666666666666666","dds":"0.22857142857142854","last_synced_commit":"a805589f9a66cb439e8671774f3d41f87ea50398"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ticky%2Flinguists-field-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ticky%2Flinguists-field-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ticky%2Flinguists-field-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ticky%2Flinguists-field-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ticky","download_url":"https://codeload.github.com/ticky/linguists-field-guide/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243810570,"owners_count":20351552,"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":[],"created_at":"2024-10-06T03:02:16.554Z","updated_at":"2025-03-16T09:33:38.645Z","avatar_url":"https://github.com/ticky.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Linguist's Field Guide 📖\n\n[![Gem Version](https://badge.fury.io/rb/linguists_field_guide.svg)](https://rubygems.org/gems/linguists_field_guide) [![Ruby](https://github.com/ticky/linguists-field-guide/workflows/Ruby/badge.svg)](https://github.com/ticky/linguists-field-guide/actions?query=workflow%3ARuby) [![codecov](https://codecov.io/gh/ticky/linguists-field-guide/branch/develop/graph/badge.svg?token=LMD2XU2S6N)](https://codecov.io/gh/ticky/linguists-field-guide)\n\nField guide for programming languages, based on the knowledge imparted by `github-linguist`.\n\n## Background\n\nThis contains data derived from GitHub's [`linguist`](https://github.com/github/linguist) Gem, which is in turn used by GitHub to detect languages of repositories and files.\n\nMany consumers don't need all of `linguist`'s features or dependencies, and in many cases the list is sufficient to aid in interoperating with GitHub and other systems which use or rely on `linguist`.\n\nThe _Linguist's Field Guide_, therefore, provides the language information known to `linguist`, without requiring _all_ of `linguist`'s functionality. Just the information, not necessarily the skills!\n\n## Installation\n\n```shell\ngem install linguists_field_guide\n```\n\n## Usage\n\n`linguists_field_guide` provides an API modeled after `linguist`'s own.\n\n`LinguistsFieldGuide::Language` provides a subset of `Linguist::Language`;\n\n- An Array of all Languages can be retrieved by calling `LinguistsFieldGuide::Language.all`\n- A specific Language can be found by using `LinguistsFieldGuide::Language.find_by_name`\n- Other `Linguist::Language` class methods (`find_by_alias`, `find_by_extension`, `find_by_filename`, etc.) are not currently provided.\n- `Language` instances contain readers for properties included in the version of `Linguist` it was built against, with these exceptions:\n  - Derived methods (`default_alias`, `escaped_name`, `hash`, etc.) are not currently provided.\n\n### Example\n\n```ruby\nrequire 'linguists_field_guide'\n\nlanguages_to_check = [\"Rust\", \"Ruby\", \"JavaScript\", \"Bash\"]\n\nlanguages_to_check.each do |language_name|\n  if LinguistsFieldGuide::Language.find_by_name(language_name)\n    puts \"⭕️ #{language_name} is a known language name\"\n  else\n    puts \"❌ #{language_name} isn't a known language name!\"\n  end\nend\n```\n\nConsole output:\n\n```text\n⭕️ Rust is a known language name\n⭕️ Ruby is a known language name\n⭕️ JavaScript is a known language name\n❌ Bash isn't a known language name!\n```\n\n## Development\n\n### Requirements\n\n* Ruby\n* Bundler\n\n### Initial setup\n\nTo install all the Ruby and Javascript dependencies, you can run:\n\n```bash\nbundle install\n```\n\nTo update the Ruby source files based on the `emoji-regex` library:\n\n```bash\nrake regenerate\n```\n\n### Specs\n\nA spec suite is provided, which can be run as:\n\n```bash\nrake spec\n```\n\n### Creating a release\n\n1. Update the version in [linguists_field_guide.gemspec](linguists_field_guide.gemspec)\n1. `rake release`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fticky%2Flinguists-field-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fticky%2Flinguists-field-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fticky%2Flinguists-field-guide/lists"}