{"id":19935110,"url":"https://github.com/optimizely/scribesass-parser","last_synced_at":"2025-05-03T12:31:01.605Z","repository":{"id":35577813,"uuid":"39850215","full_name":"optimizely/scribesass-parser","owner":"optimizely","description":"Automatically generate documentation for Sass files.","archived":true,"fork":false,"pushed_at":"2019-07-25T06:41:30.000Z","size":65,"stargazers_count":3,"open_issues_count":0,"forks_count":2,"subscribers_count":104,"default_branch":"master","last_synced_at":"2025-03-16T13:42:15.385Z","etag":null,"topics":[],"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/optimizely.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}},"created_at":"2015-07-28T18:13:34.000Z","updated_at":"2023-09-25T15:14:55.000Z","dependencies_parsed_at":"2022-09-18T01:00:48.783Z","dependency_job_id":null,"html_url":"https://github.com/optimizely/scribesass-parser","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optimizely%2Fscribesass-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optimizely%2Fscribesass-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optimizely%2Fscribesass-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/optimizely%2Fscribesass-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/optimizely","download_url":"https://codeload.github.com/optimizely/scribesass-parser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252190674,"owners_count":21708925,"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-11-12T23:18:48.276Z","updated_at":"2025-05-03T12:31:01.330Z","avatar_url":"https://github.com/optimizely.png","language":"JavaScript","readme":"# ScribeSass\n\nParse SCSS comments and return a JSON object.\n\n## Usage\n\nRequire `scribesass-parser` and provide it a path to a `.scss` file.\n\n```js\nvar scribeSass = require('scribesass-parser');\n\n// Provide path to a file and receive an array of files containing `path` and `ast` properties.\nscribeSass.create('main.scss', function(err, files) {\n  // Get an object of group objects containing file objects.\n  var groups = scribeSass.getGroups(files);\n\n  // Loop through the files.\n  for (var i = 0; i \u003c files.length; i++) {\n    // Path to the file.\n    var path = files[i].path;\n\n    // Get SCSS from an AST.\n    var scss = scribeSass.getScss(files[i].ast);\n\n    // Get object of file properties from AST.\n    var fileProperties = scribeSass.getFileProperties(files[i].ast);\n\n    // Get array of parsed comment objects and ASTs from AST.\n    // ```js\n    // comments = [{\n    //   properties = {...},\n    //   ast = {...},\n    // }]\n    // ```\n    var comments = scribeSass.getComments(files[i].ast);\n  }\n});\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptimizely%2Fscribesass-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foptimizely%2Fscribesass-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foptimizely%2Fscribesass-parser/lists"}