Comments (4)
Pl add usage
from code-insight.
Is there any specific topic I can help you with?
Each of CLI commands has help on all arguments/options and there is sample config file in README.md. This should be enough to get started unless I've missed something?
from code-insight.
Hi Alex,
Yes I need to use it in projects as code reviewer, Please share any documentation of usage, I have cloned the repo in my local machine,
Thank you for your quick response
from code-insight.
Any specific commands you're interested it?
I personally use combination of sync
and bc
commands. The sync
commands scans project code and builds database from it. And the bc
command is able to compare 2 given scans and show if new version has introduced any BC breaks.
- It it designed to work as PHAR file and I was supposed to create PHAR on next release. Since no release happened yet no PHAR is available. Luckily if you have Box installed (see https://github.com/box-project/box2), then inside cloned repo (of Code Insight repo) you can run
box build
and that will createcode-inside.phar
file in thebuild
folder (if it doesn't then please create emptybuild
folder yourself and rerunbox build
). - Copy the
code-insight.phar
somewhere in PATH. - Go to project folder you want to scan.
- Create
.code-insight.json
file (specify where source code is and what autoloader to use). - Run the
code-insight.phar sync
command to create DB for initial code version.
From this point you have 2 options on how to get BC break report:
Option 1:
- have old a new codebase in different folders, where a
.code-insight.json
file - go to project folder with changes
- run
code-insight.phar bc old_folder
Option 2
- have single folder with codebase
- go to project folder
- before making changes run
code-insight.phar sync
command - after making changes run
code-insight.phar sync --project-fork "with-changes"
(thewith-changes
is name to indicate your changes used later) - run
code-insight.phar bc --target-project-fork "with-changes"
Then you should see if you've introduced any breaks.
from code-insight.
Related Issues (20)
- Allow commit-based version comparison (bc, cs command) HOT 1
- Add "--format" option to "bc" command HOT 1
- Allow ignoring specific BC breaks for "bc" command
- Change in protected members of final class should be ignored
- Moving property/method from/to static should be a bc break
- Rename of PHP5 into PHP4 constructor shouldn't be considered as bc break
- In-Portal class BC checker doesn't detect old-style tag declaration HOT 1
- In-Portal class BC checker false positive for tag detection
- Turning parameter into optional parameter is considered as bc break
- Add config & file locator HOT 1
- Allow BC break detection between main project db and the fork
- Add compatibility with PHPUnit 6 HOT 1
- Release file not found HOT 1
- Add "collect" comand HOT 1
- Add "print" command HOT 1
- Add "bc" command HOT 2
- Add "deprecations" command
- Add "cs" command HOT 1
- Added optional parameter is considered as bc break
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from code-insight.