{"id":13528193,"url":"https://github.com/SheetJS/js-word","last_synced_at":"2025-04-01T11:31:09.514Z","repository":{"id":6145181,"uuid":"7374137","full_name":"SheetJS/js-word","owner":"SheetJS","description":":black_nib: Word Processing Document Library ","archived":false,"fork":false,"pushed_at":"2022-05-21T09:31:33.000Z","size":80493,"stargazers_count":1309,"open_issues_count":4,"forks_count":206,"subscribers_count":49,"default_branch":"master","last_synced_at":"2024-10-29T22:37:40.686Z","etag":null,"topics":["data","doc","docx","word","xml"],"latest_commit_sha":null,"homepage":"http://wordjs.com","language":"Rich Text Format","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SheetJS.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-12-30T06:26:45.000Z","updated_at":"2024-09-25T07:09:49.000Z","dependencies_parsed_at":"2022-08-06T19:15:18.188Z","dependency_job_id":null,"html_url":"https://github.com/SheetJS/js-word","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SheetJS%2Fjs-word","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SheetJS%2Fjs-word/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SheetJS%2Fjs-word/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SheetJS%2Fjs-word/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SheetJS","download_url":"https://codeload.github.com/SheetJS/js-word/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238523986,"owners_count":19486601,"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":["data","doc","docx","word","xml"],"created_at":"2024-08-01T06:02:17.411Z","updated_at":"2025-04-01T11:31:04.503Z","avatar_url":"https://github.com/SheetJS.png","language":"Rich Text Format","readme":"# [SheetJS js-word](http://wordjs.com)\n\nParser and writer for various word processing doc formats. Pure-JS cleanroom\nimplementation from official specifications, related documents, and test files.\nEmphasis on parsing and writing robustness, cross-format feature compatibility\nwith a unified JS representation, and maximal browser compatibility.\n\n\n## Test Files\n\nTest files should be placed in the `test_files` directory, in the appropriate\nsubdirectory for the filetype.  For example, DOCX files should be placed in\n`test_files\\docx\\wordjs` and RTF files should be in `test_files\\rtf\\wordjs`.\n\nEvery test file should be accompanied by a plain text `.txt` representation\nwhose filename is the original filename appended with `.txt`.  For example, the\nDOCX file `test_files\\docx\\wordjs\\foo.docx` pairs with the plain text file `test_files\\docx\\wordjs\\foo.docx.txt`\n\n**Generating Baselines using Word for Windows**\n\n0. Ensure you have PowerShell version 7.0 or greater\n1. Run `Set-ExecutionPolicy RemoteSigned` OR `Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass` in Powershell (PS) Admin 7.0\n2. Have the PS script in the root of the repo\n3. Run `.\\generate_txt.ps1 .\\test_files\\EXT_TYPE\\FOLDER` (ex. `.\\generate_txt.ps1 .\\test_files\\docx\\apachepoi`)\n\nOn first run, if a test file does not have an accompanying `.txt` file, the\nscript will open Word and save the file as plaintext.  Word will rapidly open\nand close during this process.\n\nThe script will not attempt to open Word or try to generate `.txt` files if they\nalready exist.  After a clean run, Word should not open on future runs.\n\nThe script will halt for documents that are broken in certain ways.  Word will\ndisplay a prompt, stalling the automated process.  Those documents can be\nskipped by creating a `.skip` file as described below.\n\n\n**Skipping Files**\n\nThe script will look for files with the `.skip` extension and skip processing\nthe base file.  For example, if `test_files\\docx\\wordjs\\Hello.docx.skip` exists,\nthe script will not attempt to process `test_files\\docx\\wordjs\\Hello.docx`\n\nWhen the UI blocks (for example, on a VBA error with `ThisDocument`), the\ncorresponding `.skip` file should be created manually.  The script merely tests\nif the file exists, so the content is immaterial and a single letter suffices.\n\n**Generating `.skip` files**\n\nThe script will attempt to open password-protected documents using the password\n\"WordJS\".  The script will not halt but it will not generate a text file. Instead, \nan output would be written to terminal indicating a skip and will generate a `.skip` \nwhen encountered. \n\n## License\n\nPlease consult the attached LICENSE file for details.  All rights not explicitly\ngranted by the Apache 2.0 License are reserved by the Original Author.\n\n\n## References\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cb\u003eOSP-covered Specifications\u003c/b\u003e (click to show)\u003c/summary\u003e\n\n - `MS-CFB`: Compound File Binary File Format\n - `MS-DOC`: Word (.doc) Binary File Format\n - `RTF`: Rich Text Format\n\n\u003c/details\u003e\n\n- ISO/IEC 29500:2012(E) \"Information technology — Document description and processing languages — Office Open XML File Formats\"\n- Open Document Format for Office Applications Version 1.3 (25 December 2019)\n\n[![Analytics](https://ga-beacon.appspot.com/UA-36810333-1/SheetJS/js-word?pixel)](https://github.com/SheetJS/js-word)\n","funding_links":[],"categories":["Rich Text Format"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSheetJS%2Fjs-word","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSheetJS%2Fjs-word","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSheetJS%2Fjs-word/lists"}