generated from openforge/capacitor-game-services
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from openforge/feat/capacitor-4-refactor
feat/capacitor-4-refactor
- Loading branch information
Showing
8,579 changed files
with
2,850,250 additions
and
3,336 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Contributing | ||
|
||
This guide provides instructions for contributing to this Capacitor plugin. | ||
|
||
## Developing | ||
|
||
### Local Setup | ||
|
||
1. Fork and clone the repo. | ||
1. Install the dependencies. | ||
|
||
```shell | ||
npm install | ||
``` | ||
|
||
1. Install SwiftLint if you're on macOS. | ||
```shell | ||
brew install swiftlint | ||
``` | ||
### Scripts | ||
#### `npm run build` | ||
Build the plugin web assets and generate plugin API documentation using [`@capacitor/docgen`](https://github.com/ionic-team/capacitor-docgen). | ||
It will compile the TypeScript code from `src/` into ESM JavaScript in `dist/esm/`. These files are used in apps with bundlers when your plugin is imported. | ||
Then, Rollup will bundle the code into a single file at `dist/plugin.js`. This file is used in apps without bundlers by including it as a script in `index.html`. | ||
#### `npm run verify` | ||
Build and validate the web and native projects. | ||
This is useful to run in CI to verify that the plugin builds for all platforms. | ||
#### `npm run lint` / `npm run fmt` | ||
Check formatting and code quality, autoformat/autofix if possible. | ||
This template is integrated with ESLint, Prettier, and SwiftLint. Using these tools is completely optional, but the [Capacitor Community](https://github.com/capacitor-community/) strives to have consistent code style and structure for easier cooperation. | ||
## Publishing | ||
There is a `prepublishOnly` hook in `package.json` which prepares the plugin before publishing, so all you need to do is run: | ||
```shell | ||
npm publish | ||
``` | ||
> **Note**: The [`files`](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#files) array in `package.json` specifies which files get published. If you rename files/directories or add files elsewhere, you may need to update it. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
require 'json' | ||
|
||
package = JSON.parse(File.read(File.join(__dir__, 'package.json'))) | ||
|
||
Pod::Spec.new do |s| | ||
s.name = 'CapacitorGameConnect' | ||
s.version = package['version'] | ||
s.summary = package['description'] | ||
s.license = package['license'] | ||
s.homepage = package['repository']['url'] | ||
s.author = package['author'] | ||
s.source = { :git => package['repository']['url'], :tag => s.version.to_s } | ||
s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}' | ||
s.ios.deployment_target = '13.0' | ||
s.dependency 'Capacitor' | ||
s.swift_version = '5.1' | ||
end |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.