Skip to content

Commit

Permalink
rename frida-sidecar -> sidecar
Browse files Browse the repository at this point in the history
  • Loading branch information
huan committed Aug 7, 2021
1 parent ba32156 commit 24c619c
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 16 deletions.
4 changes: 4 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
docs
examples
scripts
tests
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Sidecar

[![NPM](https://github.com/huan/sidecar/actions/workflows/npm.yml/badge.svg)](https://github.com/huan/sidecar/actions/workflows/npm.yml)
[![NPM Version](https://img.shields.io/npm/v/frida-sidecar?color=brightgreen)](https://www.npmjs.com/package/frida-sidecar)
[![NPM Version](https://img.shields.io/npm/v/sidecar?color=brightgreen)](https://www.npmjs.com/package/sidecar)
[![npm (tag)](https://img.shields.io/npm/v/sidecar/next.svg)](https://www.npmjs.com/package/wechaty-puppet-whatsapp?activeTab=versions)
[![Powered by Frida](https://img.shields.io/badge/Powered%20By-Frida-red.svg)](https://github.com/https://github.com/frida/frida)

Sidecar is a runtime hooking tool for intercepting function calls by TypeScript annotation with ease, powered by [Frida.RE](https://frida.re/).
Expand Down Expand Up @@ -144,7 +145,7 @@ with Frida system.
Example:

```ts
import { Sidecar } from 'frida-sidecar'
import { Sidecar } from 'sidecar'
@Sidecar('chatbox')
class ChatboxSidecar {}
```
Expand Down Expand Up @@ -177,7 +178,7 @@ Base class for the `Sidecar` class. All `Sidecar` class need to `extends` from t
Example:

```ts
import { SidecarBody } from 'frida-sidecar'
import { SidecarBody } from 'sidecar'
class ChatboxSidecar extends SidecarBody {}
```

Expand All @@ -192,7 +193,7 @@ The native call method decorator.
Example:

```ts
import { Call } from 'frida-sidecar'
import { Call } from 'sidecar'
class ChatboxSidecar {
@Call(0x11c9) mo () {}
}
Expand All @@ -211,7 +212,7 @@ The hook method decorator.
Example:

```ts
import { Hook } from 'frida-sidecar'
import { Hook } from 'sidecar'
class ChatboxSidecar {
@Hook(0x11f4) mt () {}
}
Expand All @@ -225,7 +226,7 @@ If the `functionTarget` is not the type of `number`, then it can be `string` or
1. `pointerTypeList` : `PointerType[]`

```ts
import { RetType } from 'frida-sidecar'
import { RetType } from 'sidecar'
class ChatboxSidecar {
@RetType('void') mo () {}
```
Expand All @@ -236,7 +237,7 @@ class ChatboxSidecar {
1. `pointerTypeList` : `PointerType[]`
```ts
import { ParamType } from 'frida-sidecar'
import { ParamType } from 'sidecar'
class ChatboxSidecar {
mo (
@ParamType('pointer', 'Utf8String') content: string,
Expand All @@ -257,7 +258,7 @@ If the `Name(parameterName)` has been set,
then the event will have additional information for the parameter names.

```ts
import { Name } from 'frida-sidecar'
import { Name } from 'sidecar'
class ChatboxSidecar {
mo (
@Name('content') content: string,
Expand All @@ -271,7 +272,7 @@ class ChatboxSidecar {
Example:

```ts
import { Ret } from 'frida-sidecar'
import { Ret } from 'sidecar'
class ChatboxSidecar {
mo () { return Ret() }
```
Expand All @@ -297,7 +298,7 @@ Example:
import {
Call,
addressTarget,
} from 'frida-sidecar'
} from 'sidecar'
class ChatboxSidecar {
@Call(
addressTarget(0x11c9)
Expand Down Expand Up @@ -580,7 +581,11 @@ You can visit them at [Sidecar Demos](https://github.com/wechaty/sidecar-demos)

## History

### Master v0.13
### Master

### v0.14

Publish to NPM as **sidecar** package name!

1. Enforce `AgentTarget` not to be decorated by neither `@ParamType` nor `@RetType` for prevent confusing.

Expand Down Expand Up @@ -612,7 +617,7 @@ You can visit them at [Sidecar Demos](https://github.com/wechaty/sidecar-demos)

### v0.1 (Jul 4, 2021)

First worked version, published to NPM as `frida-sidecar`.
First worked version, published to NPM as `sidecar`.

### v0.0.1 (Jun 13, 2021)

Expand Down
File renamed without changes.
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "frida-sidecar",
"version": "0.13.4",
"name": "sidecar",
"version": "0.14.0",
"description": "Sidecar is for easy hook/call in-process functions with TypeScript annotations.",
"main": "dist/src/mod.js",
"typings": "dist/src/mod.d.ts",
Expand All @@ -23,7 +23,7 @@
"start": "npm run example",
"example": "ts-node examples/main.ts",
"chatbox": "cd examples/chatbox && make",
"postinstall": "node scripts/post-install",
"postinstall": "node bin/post-install",
"test": "npm run lint && npm run test:unit",
"test:unit": "blue-tape -r ts-node/register \"src/**/*.spec.ts\" \"tests/**/*.spec.ts\"",
"test:unit:debug": "cross-env BROLOG_LEVEL=silly blue-tape -r ts-node/register \"src/**/*.spec.ts\" \"tests/**/*.spec.ts\"",
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/smoke-testing.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import {
RetType,
Ret,
VERSION,
} from 'frida-sidecar'
} from 'sidecar'

@Sidecar('test')
export class ChatboxSidecar extends SidecarBody {
Expand Down

0 comments on commit 24c619c

Please sign in to comment.