{"id":15005895,"url":"https://github.com/raml-org/raml-js-parser-2","last_synced_at":"2025-10-03T16:31:42.060Z","repository":{"id":57098588,"uuid":"45148206","full_name":"raml-org/raml-js-parser-2","owner":"raml-org","description":"(deprecated) ","archived":true,"fork":false,"pushed_at":"2022-02-12T14:27:55.000Z","size":31074,"stargazers_count":138,"open_issues_count":18,"forks_count":53,"subscribers_count":18,"default_branch":"master","last_synced_at":"2025-01-16T22:43:16.326Z","etag":null,"topics":["raml","raml-parser","raml-tooling"],"latest_commit_sha":null,"homepage":"","language":"RAML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raml-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2015-10-28T23:35:20.000Z","updated_at":"2024-08-08T15:17:29.000Z","dependencies_parsed_at":"2022-08-20T16:51:08.904Z","dependency_job_id":null,"html_url":"https://github.com/raml-org/raml-js-parser-2","commit_stats":null,"previous_names":[],"tags_count":117,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raml-org%2Framl-js-parser-2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raml-org%2Framl-js-parser-2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raml-org%2Framl-js-parser-2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raml-org%2Framl-js-parser-2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raml-org","download_url":"https://codeload.github.com/raml-org/raml-js-parser-2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235155986,"owners_count":18944823,"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":["raml","raml-parser","raml-tooling"],"created_at":"2024-09-24T19:01:25.636Z","updated_at":"2025-10-03T16:31:38.084Z","avatar_url":"https://github.com/raml-org.png","language":"RAML","funding_links":[],"categories":[],"sub_categories":[],"readme":"DEPRECATION NOTICE: please note that this parser is now deprecated, please use [webapi-parser](https://github.com/raml-org/webapi-parser) instead.\n\n—-\n# RAML 1.0 JS Parser\n\n[![Build Status](https://travis-ci.org/raml-org/raml-js-parser-2.svg?branch=master)](https://travis-ci.org/raml-org/raml-js-parser-2) [![Greenkeeper badge](https://badges.greenkeeper.io/raml-org/raml-js-parser-2.svg)](https://greenkeeper.io/)\n\nSee http://raml.org for more information about RAML.\n\nThis parser supports both RAML 0.8 and 1.0.\n\n## Quick start\nInstall the parser: `npm install raml-1-parser`\n\nCreate new file test.js with the following code:\n\n```\nvar raml = require(\"raml-1-parser\");\nvar apiJSON = raml.load(ramlFileName);\nconsole.log(JSON.stringify(apiJSON, null, 2));\n```\n\nwhere `ramlFileName` is a path to RAML file.\n\nRun the test: `node ./test.js`\n\n## Installation\n```\nnpm install raml-1-parser\n\nnode node_modules/raml-1-parser/test/test01.js  //synchronously loads XKCD API from local file system and prints its JSON representation\nnode node_modules/raml-1-parser/test/testAsync01.js  //asynchronously loads XKCD API from local file system and prints its JSON representation\nnode node_modules/raml-1-parser/test/test02.js  //synchronously loads XKCD API from github and prints its JSON representation\nnode node_modules/raml-1-parser/test/testAsync02.js  //asynchronously loads XKCD API from github and prints its JSON representation\n\n\n```\n\n## Usage\n* For parser usage example refer to `node_modules/raml-1-parser/test/test01.js`\n* For asynchrounous usage example refer to `node_modules/raml-1-parser/test/testAsync01.js`\n\nParser documentation: https://raml-org.github.io/raml-js-parser-2/\n\nParser JSON output schema: https://github.com/raml-org/raml-js-parser-2/blob/master/tckJsonSchema/tckJsonSchema.json\n\nGetting started guide: https://github.com/raml-org/raml-js-parser-2/blob/master/documentation/GettingStarted.md\n\nHigh-level usage example: https://github.com/raml-org/raml-js-parser-2/blob/master/examples/highlevel-AST-usage/tutorial.md\n\nValidation plugins usage example: https://github.com/raml-org/raml-js-parser-2/blob/master/examples/validationPlugins\n\n## Creating standalone browser package\n\nClone repository: `git clone https://github.com/raml-org/raml-js-parser-2.git`\n\nInstall modules: `npm install`\n\nBuild : `npm run build`\n\nGenerate browser package: `npm run generateBrowserVersion`, this will generate the package in `browserVersion` folder.\n\nTo generate debug-friendly browser package: `npm run generateBrowserVersionDev`\n\n## Setting up parser development environment\n\nClone repositories:\n* `git clone https://github.com/mulesoft-labs/yaml-ast-parser.git`\n* `git clone https://github.com/mulesoft-labs/ts-model.git`\n* `git clone https://github.com/mulesoft-labs/ts-structure-parser.git`\n* `git clone https://github.com/raml-org/raml-typesystem.git`\n* `git clone https://github.com/raml-org/raml-definition-system.git`\n* `git clone https://github.com/raml-org/raml-js-parser-2.git`\n\nFor each repository, preserving the order:\n* Install modules: `npm install`\n* Set up npm link: `npm link`\n\nFor each repository, preserving the order:\n* Open dependencies: `cd node_modules`\n* For each module `\u003cmodule_name\u003e` in `node_modules` belonging to the list above: `rm -rf \u003cmodule_name\u003e`\n* For each module `\u003cmodule_name\u003e` in `node_modules` belonging to the list above: `npm link \u003cmodule_name\u003e`\n\nFor each repository, preserving the order:\n* Build : `npm run build`\n\nHow to test: `gulp test`\n\n## Launching TCK tests\n\nExecute `npm run tck` in the commend line.\nThe script clones the `master` branch of the TCK repository to the `TCK` subfolder of the project and executes all the tests. The report file is `TCK/report.json`.\n\n## Contributing\nIf you are interested in contributing some code to this project, thanks! Please first [read and accept the Contributors Agreement](https://api-notebook.anypoint.mulesoft.com/notebooks#bc1cf75a0284268407e4).\n\nTo discuss this project, please use its [github issues](https://github.com/raml-org/raml-js-parser-2/issues) or the [RAML forum](http://forums.raml.org/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Framl-org%2Framl-js-parser-2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Framl-org%2Framl-js-parser-2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Framl-org%2Framl-js-parser-2/lists"}