paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 29 Packages Projects Releases Wiki Activity

badges: initial work for a powered by badge. #4457

Browse Source 
Signed-off-by: Andreas Stenius <git@astekk.se>
This commit is contained in:
Andreas Stenius
2021-02-17 13:59:28 +01:00
committed by Fredrik Adelöw
parent 9570256146
commit 81846585db
25 changed files with 667 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/badges/.eslintrc.js
+3
View File
@@ -0,0 +1,3 @@
module.exports = {
extends: [require.resolve('@backstage/cli/config/eslint')],
};
plugins/badges/README.md
+10
View File
@@ -0,0 +1,10 @@
# badges
Welcome to the badges plugin!
_This plugin was created through the Backstage CLI_
## Links
- [Backend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/badges-backend)
- [The Backstage homepage](https://backstage.io)
plugins/badges/dev/index.tsx
+28
View File
@@ -0,0 +1,28 @@
/*
* Copyright 2021 Spotify AB
*
* 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.
*/
import React from 'react';
import { createDevApp } from '@backstage/dev-utils';
import { badgesPlugin, EntityBadgesCard } from '../src/plugin';
import { badgesDevPlugin, BadgesDevPage } from './plugin';
createDevApp()
.registerPlugin(badgesPlugin)
.registerPlugin(badgesDevPlugin)
.addPage({
element: <BadgesDevPage />,
title: 'Dev Page',
})
.render();
plugins/badges/dev/page.tsx
+38
View File
@@ -0,0 +1,38 @@
/*
* Copyright 2021 Spotify AB
*
* 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.
*/
import React from 'react';
import { Typography, Grid } from '@material-ui/core';
import { Content, Header, Page, ContentHeader } from '@backstage/core';
import { EntityBadgesCard } from '../src';
export default () => {
return (
<Page themeId="home">
<Header
title="Badges Dev Page"
subtitle="Showcasing the EntityBadgesCard component"
/>
<Content>
<ContentHeader title="EntityBadgesCard" />
<Grid container>
<Grid item xs={12} lg={6}>
<EntityBadgesCard />
</Grid>
</Grid>
</Content>
</Page>
);
};
plugins/badges/dev/plugin.ts
+39
View File
@@ -0,0 +1,39 @@
/*
* Copyright 2021 Spotify AB
*
* 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.
*/
import {
createPlugin,
createRoutableExtension,
createRouteRef,
} from '@backstage/core';
import BadgesDevPageComponent from './page';
const devRouteRef = createRouteRef({
title: 'Badges (Dev Page)',
});
export const badgesDevPlugin = createPlugin({
id: 'badges-dev',
routes: {
root: devRouteRef,
},
});
export const BadgesDevPage = badgesDevPlugin.provide(
createRoutableExtension({
component: () => import('./page').then(m => m.default),
mountPoint: devRouteRef,
}),
);
plugins/badges/package.json
+48
View File
@@ -0,0 +1,48 @@
{
"name": "@backstage/plugin-badges",
"version": "0.1.1",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
"publishConfig": {
"access": "public",
"main": "dist/index.esm.js",
"types": "dist/index.d.ts"
},
"scripts": {
"build": "backstage-cli plugin:build",
"start": "backstage-cli plugin:serve",
"lint": "backstage-cli lint",
"test": "backstage-cli test",
"diff": "backstage-cli plugin:diff",
"prepack": "backstage-cli prepack",
"postpack": "backstage-cli postpack",
"clean": "backstage-cli clean"
},
"dependencies": {
"@backstage/core": "^0.6.1",
"@backstage/plugin-catalog-react": "^0.0.3",
"@backstage/theme": "^0.2.3",
"@material-ui/core": "^4.11.0",
"@material-ui/icons": "^4.9.1",
"@material-ui/lab": "4.0.0-alpha.45",
"react": "^16.13.1",
"react-dom": "^16.13.1",
"react-use": "^15.3.3"
},
"devDependencies": {
"@backstage/cli": "^0.6.0",
"@backstage/dev-utils": "^0.1.10",
"@backstage/test-utils": "^0.1.7",
"@testing-library/jest-dom": "^5.10.1",
"@testing-library/react": "^10.4.1",
"@testing-library/user-event": "^12.0.7",
"@types/jest": "^26.0.7",
"@types/node": "^12.0.0",
"cross-fetch": "^3.0.6",
"msw": "^0.21.2"
},
"files": [
"dist"
]
}
plugins/badges/src/components/EntityBadgesCard.tsx
+48
View File
@@ -0,0 +1,48 @@
/*
* Copyright 2021 Spotify AB
*
* 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.
*/
import React from 'react';
import { Typography } from '@material-ui/core';
import { CodeSnippet, InfoCard } from '@backstage/core';
import { useEntity } from '@backstage/plugin-catalog-react';
export const EntityBadgesCard = () => {
const { entity } = useEntity();
// TODO: extract kind, namespace, entity name from entity data...
const { kind, namespace, entityname } = {
kind: 'Component',
namespace: 'default',
entityname: 'demo',
};
// TODO: get url for backstage and the badges api
const backstage_ui = 'http://localhost:3000';
const backstage_api = 'http://localhost:7000';
const badge = `${backstage_api}/badges/${kind}/${namespace}/${entityname}`;
const target = backstage_ui;
const markdown_code = `[![Powered by Backstage](${badge})](${target})`;
return (
<InfoCard title="Badges">
<Typography paragraph>
Paste the following snippet in your <code>README.md</code> or other
markdown file, to get a powered by backstage badge:
</Typography>
<img src={badge} alt="Powered by Backstage badge" />
<CodeSnippet text={markdown_code} showCopyCodeButton />
</InfoCard>
);
};
plugins/badges/src/index.ts
+16
View File
@@ -0,0 +1,16 @@
/*
* Copyright 2021 Spotify AB
*
* 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.
*/
export { badgesPlugin, EntityBadgesCard } from './plugin';
plugins/badges/src/plugin.test.ts
+22
View File
@@ -0,0 +1,22 @@
/*
* Copyright 2021 Spotify AB
*
* 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.
*/
import { badgesPlugin } from './plugin';
describe('badges', () => {
it('should export plugin', () => {
expect(badgesPlugin).toBeDefined();
});
});
plugins/badges/src/plugin.ts
+29
View File
@@ -0,0 +1,29 @@
/*
* Copyright 2021 Spotify AB
*
* 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.
*/
import { createPlugin, createComponentExtension } from '@backstage/core';
export const badgesPlugin = createPlugin({
id: 'badges',
});
export const EntityBadgesCard = badgesPlugin.provide(
createComponentExtension({
component: {
lazy: () =>
import('./components/EntityBadgesCard').then(m => m.EntityBadgesCard),
},
}),
);
plugins/badges/src/routes.ts
+21
View File
@@ -0,0 +1,21 @@
/*
* Copyright 2021 Spotify AB
*
* 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.
*/
import { createRouteRef } from '@backstage/core';
export const badgeRouteRef = createRouteRef({
title: 'Powered By Badge',
path: 'badges/:kind/:namespace/:entityname',
});
plugins/badges/src/setupTests.ts
+17
View File
@@ -0,0 +1,17 @@
/*
* Copyright 2021 Spotify AB
*
* 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.
*/
import '@testing-library/jest-dom';
import 'cross-fetch/polyfill';