Skip to content

Commit

Permalink
expose getMeta() helper
Browse files Browse the repository at this point in the history
  • Loading branch information
retrofox committed Feb 7, 2025
1 parent 1a460d7 commit 694b586
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 0 deletions.
1 change: 1 addition & 0 deletions packages/site-admin/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
## 0.0.1-beta.1

- Introduce package. Create skeleton.
- Expose [getMeta()]('./src/utils/meta/Readme.md)
4 changes: 4 additions & 0 deletions packages/site-admin/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/*
* Utils
*/
export * from './utils/meta';
11 changes: 11 additions & 0 deletions packages/site-admin/src/utils/meta/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Site Admin Meta Helper

Returns the name, description, and version of the Site Admin package.

## Usage
```typescript
import { getSiteAdminMeta } from '@automattic/site-admin';

const meta = getSiteAdminMeta();
console.log(`The package version is ${meta.version}`);
```
22 changes: 22 additions & 0 deletions packages/site-admin/src/utils/meta/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/**
* Internal dependencies
*/
import { name, version, description } from '../../../package.json';

type Meta = {
name: string;
version: string;
description: string;
};

/**
* Get the site admin meta data.
* @returns {Meta} Site admin meta data.
*/
export function getMeta(): Meta {
return {
name,
version,
description,
};
}

0 comments on commit 694b586

Please sign in to comment.