Re-structure project and use Bun (#63)

Author: chrispader

.bundle/config

@@ -0,0 +1,97 @@
+module.exports = {
+  root: true,
+  extends: [
+    '@react-native',
+    'plugin:@typescript-eslint/recommended-type-checked',
+    'plugin:@typescript-eslint/stylistic-type-checked',
+    'plugin:prettier/recommended',
+  ],
+  plugins: ['@typescript-eslint', 'prettier'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: true,
+    tsconfigRootDir: __dirname,
+    ecmaFeatures: {
+      jsx: true,
+    },
+    ecmaVersion: 2018,
+    sourceType: 'module',
+  },
+  rules: {
+    'prettier/prettier': [
+      'warn',
+      {
+        quoteProps: 'consistent',
+        singleQuote: true,
+        tabWidth: 2,
+        trailingComma: 'es5',
+        useTabs: false,
+      },
+    ],
+    // eslint
+    'semi': 'off',
+    'curly': ['warn', 'multi-or-nest', 'consistent'],
+    'no-mixed-spaces-and-tabs': ['warn', 'smart-tabs'],
+    'no-async-promise-executor': 'warn',
+    'require-await': 'warn',
+    'no-return-await': 'warn',
+    'no-await-in-loop': 'warn',
+    'comma-dangle': 'off', // prettier already detects this
+    'no-restricted-syntax': [
+      'error',
+      {
+        selector: 'TSEnumDeclaration',
+        message:
+          "Enums have various disadvantages, use TypeScript's union types instead.",
+      },
+    ],
+    // prettier
+    'prettier/prettier': ['warn'],
+    // typescript
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/no-unused-vars': [
+      'error',
+      {
+        vars: 'all',
+        args: 'after-used',
+        ignoreRestSiblings: false,
+        varsIgnorePattern: '^_',
+        argsIgnorePattern: '^_',
+      },
+    ],
+    '@typescript-eslint/no-namespace': 'off',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'error',
+    '@typescript-eslint/no-floating-promises': 'off',
+    // react plugin
+    'react/no-unescaped-entities': 'off',
+    // react native plugin
+    'react-native/no-unused-styles': 'warn',
+    'react-native/split-platform-components': 'off',
+    'react-native/no-inline-styles': 'warn',
+    'react-native/no-color-literals': 'off',
+    'react-native/no-raw-text': 'off',
+    'react-native/no-single-element-style-arrays': 'warn',
+    '@typescript-eslint/strict-boolean-expressions': [
+      'error',
+      {
+        allowString: false,
+        allowNullableObject: false,
+        allowNumber: false,
+        allowNullableBoolean: true,
+      },
+    ],
+    '@typescript-eslint/no-non-null-assertion': 'error',
+    '@typescript-eslint/no-unnecessary-condition': 'error',
+    '@typescript-eslint/consistent-type-imports': 'warn',
+
+    // react hooks
+    'react-hooks/exhaustive-deps': [
+      'error',
+      {
+        additionalHooks:
+          '(useDerivedValue|useAnimatedStyle|useAnimatedProps|useWorkletCallback|useFrameProcessor|useSkiaFrameProcessor)',
+      },
+    ],
+  },
+}

.eslintrc.js

@@ -1,3 +1,4 @@
 *.pbxproj -text
 # specific for windows script files
-*.bat text eol=crlf
+*.bat text eol=crlf
+.lockb binary diff=lockb

.gitattributes

@@ -58,15 +58,20 @@ example/vendor/bundle
 #
 node_modules/
 npm-debug.log
-yarn-debug.log
-yarn-error.log
 
 # BUCK
 buck-out/
 \.buckd/
+
+#Android
 android/app/libs
 android/keystores/debug.keystore
 android/.cxx
+**/android/bin
+**/android/build
+
+**/android/.project
+**/.settings
 
 # Expo
 .expo/*
@@ -75,8 +80,11 @@ android/.cxx
 lib/
 # Gradle
 android/gradle/
-android/gradle*
+android/.gradle
 
 # Yalc
 .yalc
 yalc.lock
+
+# Typescript
+**/tsconfig.tsbuildinfo

.gitignore

@@ -0,0 +1,8 @@
+module.exports = {
+  quoteProps: "consistent",
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: "es5",
+  useTabs: false,
+  semi: false,
+};

.prettierrc.js

@@ -4,54 +4,54 @@ We want this community to be friendly and respectful to each other. Please follo
 
 ## Development workflow
 
-To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
+To get started with the project, run `bun` in the root directory to install the required dependencies for each package:
 
 ```sh
-yarn
+bun
 ```
 
 While developing, you can run the [example app](/example/) to test your changes.
 
 To start the packager:
 
 ```sh
-yarn example start
+bun example start
 ```
 
 To run the example app on Android:
 
 ```sh
-yarn example android
+bun example android
 ```
 
 To run the example app on iOS:
 
 ```sh
-yarn example ios
+bun example ios
 ```
 
 Make sure your code passes TypeScript and ESLint. Run the following to verify:
 
 ```sh
-yarn typescript
-yarn lint
+bun typescript
+bun lint
 ```
 
 To fix formatting errors, run the following:
 
 ```sh
-yarn lint --fix
+bun lint --fix
 ```
 
 Remember to add tests for your change if possible. Run the unit tests by:
 
 ```sh
-yarn test
+bun test
 ```
 
 To edit the Objective-C files, open `example/ios/SequelExample.xcworkspace` in XCode and find the source files at `Pods > Development Pods > react-native-quick-sqlite`.
 
-To edit the Kotlin files, open `example/android` in Android studio and find the source files at `reactnativequicksqlite` under `Android`.
+To edit the Kotlin files, open `example/android` in Android studio and find the source files at `rnquicksqlite` under `Android`.
 
 ### Commit message convention
 
@@ -78,13 +78,13 @@ Our pre-commit hooks verify that the linter and tests pass when committing.
 
 The `package.json` file contains various scripts for common tasks:
 
-- `yarn bootstrap`: setup project by installing all dependencies and pods.
-- `yarn typescript`: type-check files with TypeScript.
-- `yarn lint`: lint files with ESLint.
-- `yarn test`: run unit tests with Jest.
-- `yarn example start`: start the Metro server for the example app.
-- `yarn example android`: run the example app on Android.
-- `yarn example ios`: run the example app on iOS.
+- `bun bootstrap`: setup project by installing all dependencies and pods.
+- `bun typescript`: type-check files with TypeScript.
+- `bun lint`: lint files with ESLint.
+- `bun test`: run unit tests with Jest.
+- `bun example start`: start the Metro server for the example app.
+- `bun example android`: run the example app on Android.
+- `bun example ios`: run the example app on iOS.
 
 ### Sending a pull request
 

.ruby-version

@@ -2,7 +2,7 @@
 
 <div align="center">
   <pre align="center">
-    yarn add react-native-quick-sqlite
+    bun add react-native-quick-sqlite
     npx pod-install</pre>
   <a align="center" href="https://github.com/mrousavy?tab=followers">
     <img src="https://img.shields.io/github/followers/mrousavy?label=Follow%20%40mrousavy&style=social" />
@@ -235,7 +235,7 @@ Starting on Node14 all files that need to be accessed by third-party modules nee
 After you have applied that change, do:
 
 ```sh
-yarn patch-package --exclude 'nothing' typeorm
+bun patch-package --exclude 'nothing' typeorm
 ```
 
 Now every time you install your node_modules that line will be added.
@@ -260,7 +260,7 @@ plugins: [
 You will need to install the babel `module-resolver` plugin:
 
 ```sh
-yarn add babel-plugin-module-resolver
+bun add babel-plugin-module-resolver
 ```
 
 Finally, you will now be able to start the app without any metro/babel errors (you will also need to follow the instructions on how to setup TypeORM), now we can feed the driver into TypeORM:
@@ -280,7 +280,7 @@ datasource = new DataSource({
 
 # Loading existing DBs
 
-The library creates/opens databases by appending the passed name plus, the [documents directory on iOS](https://github.com/margelo/react-native-quick-sqlite/blob/733e876d98896f5efc80f989ae38120f16533a66/ios/QuickSQLite.mm#L34-L35) and the [files directory on Android](https://github.com/margelo/react-native-quick-sqlite/blob/main/android/src/main/java/com/reactnativequicksqlite/QuickSQLiteBridge.java#L16), this differs from other SQL libraries (some place it in a `www` folder, some in androids `databases` folder, etc.).
+The library creates/opens databases by appending the passed name plus, the [documents directory on iOS](https://github.com/margelo/react-native-quick-sqlite/blob/733e876d98896f5efc80f989ae38120f16533a66/ios/QuickSQLite.mm#L34-L35) and the [files directory on Android](https://github.com/margelo/react-native-quick-sqlite/blob/main/android/src/main/java/com/margelo/rnquicksqlite/QuickSQLiteBridge.java#L16), this differs from other SQL libraries (some place it in a `www` folder, some in androids `databases` folder, etc.).
 
 If you have an existing database file you want to load you can navigate from these directories using dot notation. e.g. `../www/myDb.sqlite`. Note that on iOS the file system is sand-boxed, so you cannot access files/directories outside your app bundle directories.
 
@@ -323,7 +323,7 @@ quickSqliteFlags="<SQLITE_FLAGS>"
 
 On iOS, the SQLite database can be placed in an app group, in order to make it accessible from other apps in that app group. E.g. for sharing capabilities.
 
-To use an app group, add the app group ID as the value for the `ReactNativeQuickSQLite_AppGroup` key in your project's `Info.plist` file. You'll also need to configure the app group in your project settings. (Xcode -> Project Settings -> Signing & Capabilities -> Add Capability -> App Groups)
+To use an app group, add the app group ID as the value for the `RNQuickSQLite_AppGroup` key in your project's `Info.plist` file. You'll also need to configure the app group in your project settings. (Xcode -> Project Settings -> Signing & Capabilities -> Add Capability -> App Groups)
 
 ## Community Discord