Reorganize file and directory structure

[antaranyan]

Proposing top-level layout for src/ like:

• src/ - root for source code
  • cli/ - command-line interface, using api/
  • api/ - main functionality
    • ports/ - defined interfaces for necessary adapters
  • api-adapter-playwright - implementation for the defined ports/ using Playwright
  • common/ - shared utilities and types

NOTE: This may be not enough organization when more functionality appears utilizing various API and adapters.

[antaranyan]

As our CLI-related functionality will take place mostly in src/, we can keep an single executable script for NPM in the root.

{
  "name": "machina",
  "bin": "./cli.js"
}

[antaranyan]

NOTE: This may be not enough organization when more functionality appears utilizing various API and adapters.

Better* layout can be:

• twitter-api - high-level functions and their dependencies
  • ports - defined interfaces for necessary adapters
• twitter-model - types, domain logic, etc.
• twitter-browser-adapter-playwright - port implementation using Playwright.

Pros

• Scales well.
  • For new features like scraping Instagram - instagram-api, instagram-model, ...
  • For various adapters like Puppeteer instead of Playwright - twitter-browser-adapter-puppeteer
• Overhead is not much
  • Some of it contributes to better naming

Cons

• Lego naming can take it only too far before getting too long
  • E.g. twitter-browser-adapter-playwright is the longest I'd like to deal with
  • Maybe can solve it with umbrella directories, maybe not