Skip to content

Commit

Permalink
ExPlat: introduce empty JS package (#37655)
Browse files Browse the repository at this point in the history
* ExPlay: introduce empty package

* Fix tests

* Remove mirror repo
  • Loading branch information
IanRamosC authored Jun 6, 2024
1 parent 7f85589 commit 87fa06c
Show file tree
Hide file tree
Showing 12 changed files with 139 additions and 0 deletions.
9 changes: 9 additions & 0 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions projects/js-packages/explat/.gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Files not needed to be distributed in the package.
.gitattributes export-ignore
node_modules export-ignore

# Files to exclude from the mirror repo
/changelog/** production-exclude
/.eslintrc.cjs production-exclude
2 changes: 2 additions & 0 deletions projects/js-packages/explat/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
vendor/
node_modules/
7 changes: 7 additions & 0 deletions projects/js-packages/explat/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

24 changes: 24 additions & 0 deletions projects/js-packages/explat/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# explat

JS package component and utils for A/B testing using ExPlat

## How to install explat

### Installation From Git Repo

## Contribute

## Get Help

## Using this package in your WordPress plugin

If you plan on using this package in your WordPress plugin, we would recommend that you use [Jetpack Autoloader](https://packagist.org/packages/automattic/jetpack-autoloader) as your autoloader. This will allow for maximum interoperability with other plugins that use this package as well.

## Security

Need to report a security vulnerability? Go to [https://automattic.com/security/](https://automattic.com/security/) or directly to our security bug bounty site [https://hackerone.com/automattic](https://hackerone.com/automattic).

## License

explat is licensed under [GNU General Public License v2 (or later)](./LICENSE.txt)

Empty file.
4 changes: 4 additions & 0 deletions projects/js-packages/explat/changelog/initial-version
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Significance: patch
Type: added

Initial version.
31 changes: 31 additions & 0 deletions projects/js-packages/explat/composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"name": "automattic/jetpack-explat",
"description": "JS package component and utils for A/B testing using ExPlat",
"type": "library",
"license": "GPL-2.0-or-later",
"require": {},
"require-dev": {
"automattic/jetpack-changelogger": "@dev"
},
"autoload": {
"classmap": [
"src/"
]
},
"scripts": {
"test-js": [
"pnpm run test"
]
},
"repositories": [
{
"type": "path",
"url": "../../packages/*",
"options": {
"monorepo": true
}
}
],
"minimum-stability": "dev",
"prefer-stable": true
}
33 changes: 33 additions & 0 deletions projects/js-packages/explat/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"private": true,
"name": "@automattic/jetpack-explat",
"version": "0.1.0-alpha",
"description": "JS package component and utils for A/B testing using ExPlat",
"homepage": "https://github.com/Automattic/jetpack/tree/HEAD/projects/js-packages/explat/#readme",
"bugs": {
"url": "https://github.com/Automattic/jetpack/labels/[JS Package] Explat"
},
"repository": {
"type": "git",
"url": "https://github.com/Automattic/jetpack.git",
"directory": "projects/js-packages/explat"
},
"license": "GPL-2.0-or-later",
"author": "Automattic",
"scripts": {
"build": "pnpm run clean && pnpm exec tsc --pretty",
"clean": "rm -rf build/",
"test": "jest tests"
},
"devDependencies": {
"jest": "29.7.0",
"typescript": "5.0.4"
},
"exports": {
".": {
"jetpack:src": "./src/index.ts",
"types": "./build/index.d.ts",
"default": "./build/index.js"
}
}
}
2 changes: 2 additions & 0 deletions projects/js-packages/explat/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// Put your code in this `src/` folder!
// Feel free to delete or rename this file.
11 changes: 11 additions & 0 deletions projects/js-packages/explat/tests/index.test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// We recommend using `jest` for testing. If you're testing React code, we recommend `@testing-library/react` and related packages.
// Please match the versions used elsewhere in the monorepo.
//
// Please don't add new uses of `mocha`, `chai`, `sinon`, `enzyme`, and so on. We're trying to standardize on one testing framework.
//
// The default setup is to have files named like "name.test.js" (or .jsx, .ts, or .tsx) in this `tests/` directory.
// But you could instead put them in `src/`, or put files like "name.js" (or .jsx, .ts, or .tsx) in `test` or `__tests__` directories somewhere.

describe( 'ExPlat', () => {
test.todo( 'Empty test' );
} );
9 changes: 9 additions & 0 deletions projects/js-packages/explat/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"extends": "jetpack-js-tools/tsconfig.base.json",
"compilerOptions": {
"typeRoots": [ "./node_modules/@types/", "src/*" ],
"outDir": "./build/"
},
// List all sources and source-containing subdirs.
"include": [ "./src" ]
}

0 comments on commit 87fa06c

Please sign in to comment.