{"id":16783530,"url":"https://github.com/tkh44/babel-plugin-sitrep","last_synced_at":"2025-04-04T23:07:29.772Z","repository":{"id":66143834,"uuid":"103314278","full_name":"tkh44/babel-plugin-sitrep","owner":"tkh44","description":"Log all assignments and the return value of a function with a simple comment","archived":false,"fork":false,"pushed_at":"2017-10-11T23:17:15.000Z","size":28,"stargazers_count":436,"open_issues_count":5,"forks_count":29,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-14T07:50:01.734Z","etag":null,"topics":["babel","babel-plugin","babel-plugin-sitrep","console-log","logging"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tkh44.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2017-09-12T19:52:22.000Z","updated_at":"2024-08-15T19:42:57.000Z","dependencies_parsed_at":"2023-02-22T01:15:16.944Z","dependency_job_id":null,"html_url":"https://github.com/tkh44/babel-plugin-sitrep","commit_stats":{"total_commits":37,"total_committers":3,"mean_commits":"12.333333333333334","dds":"0.10810810810810811","last_synced_commit":"8c72baa4e80e60d0ab9133ffd78432b90119c490"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkh44%2Fbabel-plugin-sitrep","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkh44%2Fbabel-plugin-sitrep/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkh44%2Fbabel-plugin-sitrep/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tkh44%2Fbabel-plugin-sitrep/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tkh44","download_url":"https://codeload.github.com/tkh44/babel-plugin-sitrep/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247261603,"owners_count":20910108,"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":["babel","babel-plugin","babel-plugin-sitrep","console-log","logging"],"created_at":"2024-10-13T07:49:58.009Z","updated_at":"2025-04-04T23:07:29.739Z","avatar_url":"https://github.com/tkh44.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# babel-plugin-sitrep\n\n\u003e Log all assignments and the return value of a function with a simple comment\n\n[![npm version](https://badge.fury.io/js/babel-plugin-sitrep.svg)](https://badge.fury.io/js/babel-plugin-sitrep)\n[![Build Status](https://travis-ci.org/tkh44/babel-plugin-sitrep.svg?branch=master)](https://travis-ci.org/tkh44/babel-plugin-sitrep)\n[![codecov](https://codecov.io/gh/tkh44/babel-plugin-sitrep/branch/master/graph/badge.svg)](https://codecov.io/gh/tkh44/babel-plugin-sitrep)\n\n## Example\n\n**In**\n\n```javascript\n// sitrep\nfunction bar () {\n  var a = 'foo'\n  const b = 'bar'\n  let c = [a, b].map(x =\u003e x)\n  return c.join('-')\n}\n\n// sitrep\nvar cb = x =\u003e x.charAt(0)\n\n// sitrep\nvar cb = x =\u003e {\n  x = x + 2\n  x.charAt(0)\n  return x\n}\n\n// sitrep\nvar a = function () {\n  return 'foo'\n}\n\nconst obj = {\n  // sitrep\n  fn() {\n    let a = 5\n    return a + 5\n  }\n}\n\nclass Boom {\n  // sitrep\n  fire() {\n    let a = 2\n    return a + 5\n  }\n}\n\n// sitrep prefix\nfunction bar () {\n  var a = 'foo'\n  return a\n}\n\n```\n\n`↓ ↓ ↓ ↓ ↓ ↓`\n\n**Out**\n\n```javascript\n// sitrep\nfunction bar () {\n  console.groupCollapsed('bar');\n\n  var a = 'foo';\n  console.log('a: ', a);\n  const b = 'bar';\n  console.log('b: ', b);\n  let c = [a, b].map(x =\u003e x);\n  console.log('c: ', c);\n\n  var _returnValue = c.join('-');\n\n  console.log('Return Value:', _returnValue);\n  console.groupEnd('bar');\n  return _returnValue;\n}\n\n// sitrep\nvar cb = function (x) {\n  console.groupCollapsed('cb');\n\n  var _returnValue3 = x.charAt(0);\n\n  console.log('Return Value:', _returnValue3);\n  console.groupEnd('cb');\n  return _returnValue3;\n};\n\n// sitrep\nvar cb = function (x) {\n  console.groupCollapsed('cb');\n\n  x = x + 2;\n  console.log('x: ', x);\n  x.charAt(0);\n  var _returnValue4 = x;\n  console.log('Return Value:', _returnValue4);\n  console.groupEnd('cb');\n  return _returnValue4;\n};\n\n// sitrep\nvar a = function () {\n  console.groupCollapsed('a');\n  var _returnValue5 = 'foo';\n  console.log('Return Value:', _returnValue5);\n  console.groupEnd('a');\n\n  return _returnValue5;\n};\n\nconst obj = {\n  // sitrep\n  fn() {\n    console.groupCollapsed('fn');\n\n    let a = 5;\n    console.log('a: ', a);\n\n    var _returnValue6 = a + 5;\n\n    console.log('Return Value:', _returnValue6);\n    console.groupEnd('fn');\n    return _returnValue6;\n  }\n};\n\nclass Boom {\n  // sitrep\n  fire() {\n    console.groupCollapsed('fire');\n\n    let a = 2;\n    console.log('a: ', a);\n\n    var _returnValue7 = a + 5;\n\n    console.log('Return Value:', _returnValue7);\n    console.groupEnd('fire');\n    return _returnValue7;\n  }\n}\n\n// sitrep prefix\nfunction bar () {\n  console.groupCollapsed('(prefix) bar');\n\n  var a = 'foo';\n  console.log('a: ', a);\n\n  var _returnValue8 = c.join('-');\n\n  console.log('Return Value:', _returnValue8);\n  console.groupEnd('(prefix) bar');\n  return _returnValue8;\n}\n```\n\n## Installation\n\n```sh\nnpm install --save-dev babel-plugin-sitrep\n```\n\n## Usage\n\n### Via `.babelrc` (Recommended)\n\n**.babelrc**\n\nWithout options:\n\n```json\n{\n  \"plugins\": [\"sitrep\"]\n}\n```\n\n### Via CLI\n\n```sh\nbabel --plugins sitrep script.js\n```\n\n### Via Node API\n\n```javascript\nrequire(\"babel-core\").transform(\"code\", {\n  plugins: [\"sitrep\"]\n});\n```\n\n\n## Options\n\n### `label`\n\n`string`, defaults to `sitrep`.\n\nThis option changes the label that enables the plugin\n\n**Example**\n\nIf we set `label` to `\"log-all-the-things\"`\n\n**In**\n```javascript\n// log-all-the-things\nfunction fn(a) {\n  a = a.map(x =\u003e x)\n  return a\n}\n```\n\n```↓ ↓ ↓ ↓ ↓ ↓```\n\n**Out**\n```javascript\n// log-all-the-things\nfunction fn(a) {\n  console.groupCollapsed(\"fn\");\n\n  a = a.map(x =\u003e x);\n  console.log(\"a: \", a);\n  var _returnValue = a;\n  console.log(\"Return Value:\", _returnValue);\n  console.groupEnd(\"fn\");\n  return _returnValue;\n}\n```\n\n### `collapsed`\n\n`boolean`, defaults to `true`.\n\nThis option enables the following:\n\n - Collapse the group of console logs associated with a function\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftkh44%2Fbabel-plugin-sitrep","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftkh44%2Fbabel-plugin-sitrep","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftkh44%2Fbabel-plugin-sitrep/lists"}