generated from capacitor-community/.github
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
42 changed files
with
5,058 additions
and
14 deletions.
There are no files selected for viewing
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,2 @@ | ||
build | ||
dist |
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 @@ | ||
engine-strict=false |
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 @@ | ||
20.11.1 |
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,2 @@ | ||
build | ||
dist |
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,7 @@ | ||
# Changelog | ||
|
||
All notable changes to this project will be documented in this file. | ||
|
||
## v6.0.0 | ||
|
||
- initial release |
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 |
---|---|---|
@@ -1,3 +1,46 @@ | ||
# Contributing | ||
|
||
TODO | ||
This guide provides instructions for contributing to this Capacitor plugin. | ||
|
||
## Developing | ||
|
||
### Local Setup | ||
|
||
1. Fork and clone the repo. | ||
2. Install the dependencies. | ||
|
||
```shell | ||
npm install | ||
``` | ||
|
||
### 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 = 'CapacitorCommunityExif' | ||
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/Sources/**/*.{swift,h,m,c,cc,mm,cpp}' | ||
s.ios.deployment_target = '13.0' | ||
s.dependency 'Capacitor' | ||
s.swift_version = '5.1' | ||
end |
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,28 @@ | ||
// swift-tools-version: 5.9 | ||
import PackageDescription | ||
|
||
let package = Package( | ||
name: "CapacitorCommunityExif", | ||
platforms: [.iOS(.v13)], | ||
products: [ | ||
.library( | ||
name: "CapacitorCommunityExif", | ||
targets: ["ExifPlugin"]) | ||
], | ||
dependencies: [ | ||
.package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", branch: "main") | ||
], | ||
targets: [ | ||
.target( | ||
name: "ExifPlugin", | ||
dependencies: [ | ||
.product(name: "Capacitor", package: "capacitor-swift-pm"), | ||
.product(name: "Cordova", package: "capacitor-swift-pm") | ||
], | ||
path: "ios/Sources/ExifPlugin"), | ||
.testTarget( | ||
name: "ExifPluginTests", | ||
dependencies: ["ExifPlugin"], | ||
path: "ios/Tests/ExifPluginTests") | ||
] | ||
) |
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 |
---|---|---|
@@ -1,36 +1,172 @@ | ||
<p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p> | ||
<h3 align="center">Example</h3> | ||
<p align="center"><strong><code>@capacitor-community/example</code></strong></p> | ||
<h3 align="center">Capacitor Exif Plugin</h3> | ||
<p align="center"><strong><code>@capacitor-community/exif</code></strong></p> | ||
<p align="center"> | ||
Capacitor community plugin for something awesome. | ||
Capacitor community plugin for interacting with image exif metadata | ||
</p> | ||
|
||
<p align="center"> | ||
<img src="https://img.shields.io/maintenance/yes/2024?style=flat-square" /> | ||
<a href="https://github.com/capacitor-community/example/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/capacitor-community/example/CI?style=flat-square" /></a> | ||
<a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/l/@capacitor-community/example?style=flat-square" /></a> | ||
<a href="https://github.com/capacitor-community/exif/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/workflow/status/capacitor-community/exif/CI?style=flat-square" /></a> | ||
<a href="https://www.npmjs.com/package/@capacitor-community/exif"><img src="https://img.shields.io/npm/l/@capacitor-community/exif?style=flat-square" /></a> | ||
<br> | ||
<a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/dw/@capacitor-community/example?style=flat-square" /></a> | ||
<a href="https://www.npmjs.com/package/@capacitor-community/example"><img src="https://img.shields.io/npm/v/@capacitor-community/example?style=flat-square" /></a> | ||
<a href="https://www.npmjs.com/package/@capacitor-community/exif"><img src="https://img.shields.io/npm/dw/@capacitor-community/exif?style=flat-square" /></a> | ||
<a href="https://www.npmjs.com/package/@capacitor-community/exif"><img src="https://img.shields.io/npm/v/@capacitor-community/exif?style=flat-square" /></a> | ||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
<a href="#contributors-"><img src="https://img.shields.io/badge/all%20contributors-0-orange?style=flat-square" /></a> | ||
<!-- ALL-CONTRIBUTORS-BADGE:END --> | ||
</p> | ||
|
||
# Table of Contents | ||
|
||
- [Maintainers](#maintainers) | ||
- [About](#about) | ||
- [Plugin versions](#plugin-versions) | ||
- [Supported Platforms](#supported-platforms) | ||
- [Installation](#installation) | ||
- [Configuration](#configuration) | ||
- [API](#api) | ||
- [Troubleshooting](#troubleshooting) | ||
|
||
## Maintainers | ||
|
||
| Maintainer | GitHub | Social | | ||
| -----------| -------| -------| | ||
| Ionitron (example) | [Ionitron](https://github.com/ionitron) | [@ionitron](https://twitter.com/ionitron) | | ||
| Maintainer | GitHub | Active | | ||
| ---------- | ------------------------------- | ------ | | ||
| ryaa | [ryaa](https://github.com/ryaa) | yes | | ||
|
||
## About | ||
|
||
This plugins allows reading and setting coordinates to image files. | ||
This plugin has been primarity implemented to enhance other plugins which require coordinates to be added to images, for example https://github.com/capacitor-community/camera-preview/issues/164. | ||
|
||
**Features:** | ||
|
||
- support reading coordinates from image files | ||
- support setting coordinates to image files | ||
- supports Android and iOS platforms | ||
|
||
**NOTE**: The plugin version 6.0.0 is compatible with Capacitor 6 | ||
|
||
## Plugin versions | ||
|
||
| Capacitor version | Plugin version | | ||
| ----------------- | -------------- | | ||
| 6.x | 6.x | | ||
|
||
## Supported Platforms | ||
|
||
- iOS | ||
- Android | ||
|
||
## Installation | ||
|
||
TODO | ||
```bash | ||
npm install @capacitor-community/exif | ||
npx cap sync | ||
``` | ||
|
||
## Configuration | ||
|
||
TODO | ||
### Android | ||
This plugin will use the following project variables (defined in your app's variables.gradle file): | ||
``` | ||
androidxExifInterfaceVersion: version of androidx.exifinterface:exifinterface (default: 1.3.6) | ||
``` | ||
|
||
## API | ||
|
||
<docgen-index> | ||
|
||
* [`setCoordinates(...)`](#setcoordinates) | ||
* [`getCoordinates(...)`](#getcoordinates) | ||
* [Interfaces](#interfaces) | ||
|
||
</docgen-index> | ||
|
||
|
||
<docgen-api> | ||
<!--Update the source file JSDoc comments and rerun docgen to update the docs below--> | ||
|
||
### setCoordinates(...) | ||
|
||
```typescript | ||
setCoordinates(options: SetCoordinatesOptions) => Promise<void> | ||
``` | ||
|
||
Set the coordinates to the image EXIF metadata. | ||
|
||
| Param | Type | | ||
| ------------- | ----------------------------------------------------------------------- | | ||
| **`options`** | <code><a href="#setcoordinatesoptions">SetCoordinatesOptions</a></code> | | ||
|
||
**Since:** 6.0.0 | ||
|
||
-------------------- | ||
|
||
|
||
### getCoordinates(...) | ||
|
||
```typescript | ||
getCoordinates(options: GetCoordinatesOptions) => Promise<{ lat: number; lng: number; } | undefined> | ||
``` | ||
|
||
Get the coordinates from the image EXIF metadata. | ||
|
||
| Param | Type | | ||
| ------------- | ----------------------------------------------------------------------- | | ||
| **`options`** | <code><a href="#getcoordinatesoptions">GetCoordinatesOptions</a></code> | | ||
|
||
**Returns:** <code>Promise<{ lat: number; lng: number; }></code> | ||
|
||
**Since:** 6.0.0 | ||
|
||
-------------------- | ||
|
||
|
||
### Interfaces | ||
|
||
|
||
#### SetCoordinatesOptions | ||
|
||
| Prop | Type | Description | Since | | ||
| ----------------- | ------------------- | ------------------------------------------------------------------ | ----- | | ||
| **`pathToImage`** | <code>string</code> | The path to the image to set the coordinates to the EXIF metadata. | 6.0.0 | | ||
| **`lat`** | <code>number</code> | The latitude of the image coordinates. | 6.0.0 | | ||
| **`lng`** | <code>number</code> | The longitude of the image coordinates. | 6.0.0 | | ||
|
||
|
||
#### GetCoordinatesOptions | ||
|
||
| Prop | Type | Description | Since | | ||
| ----------------- | ------------------- | ---------------------------------------------------------------- | ----- | | ||
| **`pathToImage`** | <code>string</code> | The path to the image to get the coordinates from EXIF metadata. | 6.0.0 | | ||
|
||
</docgen-api> | ||
|
||
## Usage | ||
|
||
TODO | ||
### Set coordinates to image file | ||
|
||
``` | ||
import { Exif } from '@capacitor-community/exif'; | ||
const options: SetCoordinatesOptions = { | ||
pathToImage, | ||
lat, | ||
lng | ||
}; | ||
await this.exifPlugin.setCoordinates(options); | ||
``` | ||
|
||
### Read coordinates from image file | ||
|
||
``` | ||
import { Exif } from '@capacitor-community/exif'; | ||
const options: GetCoordinatesOptions = { pathToImage }; | ||
const coordinates: { | ||
lat: number; | ||
lng: number; | ||
} | undefined = await this.exifPlugin.getCoordinates(options); | ||
``` | ||
|
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 @@ | ||
/build |
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,60 @@ | ||
ext { | ||
junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2' | ||
androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1' | ||
androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5' | ||
androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1' | ||
androidxExifInterfaceVersion = project.hasProperty('androidxExifInterfaceVersion') ? rootProject.ext.androidxExifInterfaceVersion : '1.3.6' | ||
} | ||
|
||
buildscript { | ||
repositories { | ||
google() | ||
mavenCentral() | ||
} | ||
dependencies { | ||
classpath 'com.android.tools.build:gradle:8.2.1' | ||
} | ||
} | ||
|
||
apply plugin: 'com.android.library' | ||
|
||
android { | ||
namespace "com.ryltsov.alex.plugins.exif" | ||
compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34 | ||
defaultConfig { | ||
minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22 | ||
targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34 | ||
versionCode 1 | ||
versionName "1.0" | ||
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" | ||
} | ||
buildTypes { | ||
release { | ||
minifyEnabled false | ||
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' | ||
} | ||
} | ||
lintOptions { | ||
abortOnError false | ||
} | ||
compileOptions { | ||
sourceCompatibility JavaVersion.VERSION_17 | ||
targetCompatibility JavaVersion.VERSION_17 | ||
} | ||
} | ||
|
||
repositories { | ||
google() | ||
mavenCentral() | ||
} | ||
|
||
|
||
dependencies { | ||
implementation fileTree(dir: 'libs', include: ['*.jar']) | ||
implementation project(':capacitor-android') | ||
implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion" | ||
implementation "androidx.exifinterface:exifinterface:$androidxExifInterfaceVersion" | ||
testImplementation "junit:junit:$junitVersion" | ||
androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion" | ||
androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion" | ||
} |
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,22 @@ | ||
# Project-wide Gradle settings. | ||
|
||
# IDE (e.g. Android Studio) users: | ||
# Gradle settings configured through the IDE *will override* | ||
# any settings specified in this file. | ||
|
||
# For more details on how to configure your build environment visit | ||
# http://www.gradle.org/docs/current/userguide/build_environment.html | ||
|
||
# Specifies the JVM arguments used for the daemon process. | ||
# The setting is particularly useful for tweaking memory settings. | ||
org.gradle.jvmargs=-Xmx1536m | ||
|
||
# When configured, Gradle will run in incubating parallel mode. | ||
# This option should only be used with decoupled projects. More details, visit | ||
# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects | ||
# org.gradle.parallel=true | ||
|
||
# AndroidX package structure to make it clearer which packages are bundled with the | ||
# Android operating system, and which are packaged with your app's APK | ||
# https://developer.android.com/topic/libraries/support-library/androidx-rn | ||
android.useAndroidX=true |
Binary file not shown.
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,7 @@ | ||
distributionBase=GRADLE_USER_HOME | ||
distributionPath=wrapper/dists | ||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-all.zip | ||
networkTimeout=10000 | ||
validateDistributionUrl=true | ||
zipStoreBase=GRADLE_USER_HOME | ||
zipStorePath=wrapper/dists |
Oops, something went wrong.