| 1 |
- (window.webpackJsonp=window.webpackJsonp||[]).push([[9],{110:function(e,t,r){"use strict";r.r(t),r.d(t,"frontMatter",(function(){return l})),r.d(t,"metadata",(function(){return c})),r.d(t,"rightToc",(function(){return i})),r.d(t,"default",(function(){return u}));var n=r(2),a=r(6),o=(r(0),r(117)),l={id:"03-u-getting-started",title:"Getting started",sidebar_label:"Getting started"},c={id:"03-u-getting-started",isDocsHomePage:!1,title:"Getting started",description:"The tool is relatively simple to use. There are 3 fundamental steps:",source:"@site/docs/03-u-getting-started.md",permalink:"/docs/03-u-getting-started",editUrl:"https://metrixplusplus.github.io/docs/03-u-getting-started.md",sidebar_label:"Getting started",sidebar:"someSidebar",previous:{title:"Download and install",permalink:"/docs/02-u-download-install"},next:{title:"Workflow",permalink:"/docs/04-u-workflow"}},i=[],p={rightToc:i};function u(e){var t=e.components,r=Object(a.a)(e,["components"]);return Object(o.b)("wrapper",Object(n.a)({},p,r,{components:t,mdxType:"MDXLayout"}),Object(o.b)("p",null,"The tool is relatively simple to use. There are 3 fundamental steps:"),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"Collect the data, for example:")),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-bash"}),'> python "/path/to/metrix++.py" collect --std.code.lines.code --std.code.complexity.cyclomatic\n')),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"View the data, for example:")),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-bash"}),'> python "/path/to/metrix++.py" view\n')),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"Apply thresholds, for example:")),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-bash"}),'> python "/path/to/metrix++.py" limit --max-limit=std.code.complexity:cyclomatic:7\n')),Object(o.b)("p",null,"Please, check the advanced ",Object(o.b)("a",Object(n.a)({parentName:"p"},{href:"/docs/04-u-workflow"}),"description of the workflow")," with real examples."))}u.isMDXComponent=!0},117:function(e,t,r){"use strict";r.d(t,"a",(function(){return s})),r.d(t,"b",(function(){return m}));var n=r(0),a=r.n(n);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function l(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function c(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?l(Object(r),!0).forEach((function(t){o(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):l(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function i(e,t){if(null==e)return{};var r,n,a=function(e,t){if(null==e)return{};var r,n,a={},o=Object.keys(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n<o.length;n++)r=o[n],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=a.a.createContext({}),u=function(e){var t=a.a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):c(c({},t),e)),r},s=function(e){var t=u(e.components);return a.a.createElement(p.Provider,{value:t},e.children)},b={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},d=a.a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,l=e.parentName,p=i(e,["components","mdxType","originalType","parentName"]),s=u(r),d=n,m=s["".concat(l,".").concat(d)]||s[d]||b[d]||o;return r?a.a.createElement(m,c(c({ref:t},p),{},{components:r})):a.a.createElement(m,c({ref:t},p))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,l=new Array(o);l[0]=d;var c={};for(var i in t)hasOwnProperty.call(t,i)&&(c[i]=t[i]);c.originalType=e,c.mdxType="string"==typeof e?e:n,l[1]=c;for(var p=2;p<o;p++)l[p]=r[p];return a.a.createElement.apply(null,l)}return a.a.createElement.apply(null,r)}d.displayName="MDXCreateElement"}}]);
|
