Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jscad/io
DEPRECATED : Input Output handling for JSCAD (see the link below)
https://github.com/jscad/io
Last synced: about 2 months ago
JSON representation
DEPRECATED : Input Output handling for JSCAD (see the link below)
- Host: GitHub
- URL: https://github.com/jscad/io
- Owner: jscad
- Archived: true
- Created: 2017-04-07T12:26:20.000Z (over 7 years ago)
- Default Branch: V2
- Last Pushed: 2020-04-06T16:06:27.000Z (over 4 years ago)
- Last Synced: 2024-04-14T12:12:46.496Z (5 months ago)
- Language: JavaScript
- Homepage: https://github.com/jscad/OpenJSCAD.org/tree/V2/packages
- Size: 957 KB
- Stars: 34
- Watchers: 13
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
## io
## Input Output format handling for the JSCAD projects
[](https://lernajs.io/)
## Overview
This repository includes all the input/output format handling for the JSCAD projects, and can also be used seperatly.
> NOTE : as of September 1 2018, we will NOT be accepting new PRS against the V1 / master branch: we realistically
are not able to keep adding new features/fixes to the 'old' version and work on the very different V2.
thank you for your comprehension !
(already open PRS at that date are exempt)
### Input Format Handling (deserializers)
ie: file data => jscad code (that can be evaluated to CSG/CAG)
> note : currently serializers & deserializers are NOT symetrical as deserializers
do not generate CSG/CAG objects: there is however work done to enable CSG/CAG output directly
deserializers with optional CSG/CAG output:
- [x] amf-deserializer
- [x] dxf-deserializer
- [ ] json-deserializer
- [x] obj-deserializer
- [x] stl-deserializer
- [x] svg-deserializer
Following formats are supported as inputs:
- [AMF](https://github.com/jscad/io/blob/master/packages/amf-deserializer)
- [DXF](https://github.com/jscad/io/blob/master/packages/dxf-deserializer)
- [gcode](https://github.com/jscad/io/blob/master/packages/gcode-deserializer)
- [JSON](https://github.com/jscad/io/blob/master/packages/json-deserializer)
- [OBJ](https://github.com/jscad/io/blob/master/packages/obj-deserializer)
- [STL (binary, ASCII)](https://github.com/jscad/io/blob/master/packages/stl-deserializer)
- [SVG](https://github.com/jscad/io/blob/master/packages/svg-deserializer)
### Output Format Handling (serializers)
ie: CSG/CAG => blob
Following formats are supported as outputs:
- [AMF](https://github.com/jscad/io/blob/master/packages/amf-serializer)
- [DXF](https://github.com/jscad/io/blob/master/packages/dxf-serializer)
- [JSON](https://github.com/jscad/io/blob/master/packages/json-serializer)
- [STL (binary, ASCII)](https://github.com/jscad/io/blob/master/packages/stl-serializer)
- [SVG](https://github.com/jscad/io/blob/master/packages/svg-serializer)
- [X3D](https://github.com/jscad/io/blob/master/packages/x3d-serializer)
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Contribute](#contribute)
- [Publishing](#Publishing)
- [License](#license)
## Installation
```
npm install @jscad/io
```
## Usage
- as Node module :
```
const io = require('@jscad/io')
```
## Contribute
This library is part of the JSCAD Organization, and is maintained by a group of volunteers. We welcome and encourage anyone to pitch in but please take a moment to read the following guidelines.
* If you want to submit a bug report please make sure to follow the [Reporting Issues](https://github.com/jscad/csg.js/wiki/Reporting-Issues) guide. Bug reports are accepted as [Issues](https://github.com/jscad/io/issues/) via GitHub.
* If you want to submit a change or a patch, please see the [Contributing guidelines](https://github.com/jscad/io/blob/master/CONTRIBUTING.md). New contributions are accepted as [Pull Requests](https://github.com/jscad/io/pulls/) via GithHub.
* We only accept bug reports and pull requests on **GitHub**.
* If you have a question about how to use the IO library, then please start a conversation at the [OpenJSCAD.org User Group](https://plus.google.com/communities/114958480887231067224). You might find the answer in the [OpenJSCAD.org User Guide](https://github.com/Spiritdude/OpenJSCAD.org/wiki/User-Guide).
* If you have a change or new feature in mind, please start a conversation with the [Core Developers](https://plus.google.com/communities/114958480887231067224) and start contributing changes.
Small Note: If editing this README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
## Publishing
This is for owners/ managers of the repo only, obviously :)
It is done in semi-automated manner with Lerna & conventional-commits (semantic release)
It automatically checks out the `master` branch and pulls the latest version from the remote repo
In case of doubt, please ask @kaosat-dev for help
>you need to have npm & git authorization setup beforehand
- Do a dry run first !!
```shell
npm run publish-dryrun
```
then answer 'no' to avoid publishing to either git or npm
- when you are **SURE** everything is ok and you want to publish
npm run publish
>Note: DO NOT publish the packages individually and manually , unless you have very good
reasons to, and have discussed it with the rest of the team
## License
[The MIT License (MIT)](https://github.com/jscad/io/blob/master/LICENSE)
(unless specified otherwise)