Skip to content

shapesecurity/shift-java

Repository files navigation

Shift Tools for Java

About

This project provides Java tooling around the Shift AST format.

Generating code

Code under generated-sources/ is generated by a set of scripts under build-scripts/. These are written for Node and require it to be installed.

To regenerate sources:

cd build-scripts
npm ci # install dependencies
npm run build

Contributing

  • Open a Github issue with a description of your desired change. If one exists already, leave a message stating that you are working on it with the date you expect it to be complete.
  • Fork this repo, and clone the forked repo.
  • Install dependencies with mvn.
  • Build and test in your environment with mvn compile test.
  • Create a feature branch. Make your changes. Add tests.
  • Build and test in your environment with mvn compile test.
  • Make a commit that includes the text "fixes #XX" where XX is the Github issue.
  • Open a Pull Request on Github.

License

Copyright 2017 Shape Security, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.