whatnow

An automatic task prioritisation app that tells you what to do next.

Dart ⭐ 0

README

whatnow Monorepo

A multiplatform task management monorepo organized with Dart/Flutter native pub workspaces. Task prioritization is driven by the Eisenhower Matrix (Urgent vs. Important).

Development Tasks Runner (`tool/dev.dart`)

To avoid OS differences with make, a cross-platform Dart runner script is available at tool/dev.dart:

# Show all available commands
dart run tool/dev.dart help

# Formatting & static analysis
dart run tool/dev.dart format           # Format all packages
dart run tool/dev.dart format --check   # Check formatting without modifying
dart run tool/dev.dart analyze          # Analyze with --fatal-infos
dart run tool/dev.dart fix              # Apply automated fixes
dart run tool/dev.dart fix --check      # Dry-run check for fixes

# Testing
dart run tool/dev.dart test             # Run all tests (core, cli, app)
dart run tool/dev.dart test:core        # Run core tests only
dart run tool/dev.dart test:cli         # Run CLI tests only
dart run tool/dev.dart test:app         # Run Flutter app tests only

# Building & Smoke Testing
dart run tool/dev.dart build:cli        # Compile native CLI bundle
dart run tool/dev.dart smoke:cli        # Smoke test compiled CLI binary
dart run tool/dev.dart build:app        # Build Android debug APK

# Full Local CI Verification Suite (format, analyze, fix, test, build, smoke)
dart run tool/dev.dart verify

Development Setup

Prerequisites

Flutter SDK (3.24+ recommended, includes Dart 3.5+ with native pub workspace support)
Git

Getting Started

Install dependencies across all workspaces:
```
flutter pub get
```
Verify workspace membership:
```
dart pub workspace list
```

Check formatting and linting:

dart format --output=none --set-exit-if-changed .
dart analyze --fatal-infos
dart fix --dry-run

Run all tests:

# Core & CLI tests
dart test packages/core
dart test packages/cli

# Flutter app tests
flutter test packages/app

Build and smoke test the native CLI:

cd packages/cli
dart build cli
dart run tool/smoke_cli.dart
cd ../..

Run the Flutter Android app (with an emulator or device connected):
```
cd packages/app
flutter run
```

CI/CD Pipeline

The GitHub Actions workflows mirror the established pattern from cards_with_dart and ascii_renderer:

Main CI (.github/workflows/dart.yml):
- format: Verifies code formatting across all packages.
- analyze: Runs static analysis with fatal infos.
- fix: Asserts that dart fix --dry-run reports no pending automated fixes.
- test: Multi-OS test matrix (ubuntu-latest, windows-latest, macos-latest) with Linux coverage collection.
- build-cli: Multi-OS native CLI compilation and smoke testing.
- build-android: Compiles Android debug APK and uploads artifact.
Beta Check (.github/workflows/dart-beta.yml): Weekly non-blocking sanity check against the beta SDK channel.
Release (.github/workflows/release.yml):
- Triggered on tag v*.*.* or manual dispatch.
- Validates matching pubspec.yaml version and CHANGELOG.md entry.
- Builds Linux x64, macOS ARM64, and Windows x64 CLI binaries packaged in .tar.gz and .zip.
- Builds Android release APK.
- Generates SHA256SUMS and publishes draft GitHub Release with release notes.
Dependabot (.github/dependabot.yml): Weekly dependency update checks for Pub packages and GitHub Actions.

Using This Repository as a Template

4. Re-resolve and Verify

flutter pub get
dart run tool/dev.dart verify

Optional: Publishing Packages to pub.dev

By default, all workspace packages are set to publish_to: none to prevent accidental public release of private code or name collisions.

If you want to publish whatnow_core as an open-source library and whatnow_cli as a globally activatable command-line tool, follow these steps:

1. Requirements for pub.dev

Remove publish_to: none:
Remove this line from packages/core/pubspec.yaml and packages/cli/pubspec.yaml. (Keep it in root pubspec.yaml and packages/app/pubspec.yaml).
Ensure Globally Unique Names:
Check pub.dev to ensure your package names are available.

Add Pana Metadata:
Each published package must have:

description: >-
  A concise description between 60 and 180 characters explaining what the package does.
repository: https://github.com/<user>/<repo>
issue_tracker: https://github.com/<user>/<repo>/issues
topics:
  - cli
  - productivity

Specify Explicit Dependency Versions:
Within a pub workspace, local packages can depend on sibling packages without version numbers. However, pub.dev requires explicit versions:
```
# In packages/cli/pubspec.yaml:
dependencies:
  myproject_core: ^0.1.0 # Must match the published version of core
```
Package-Level Files:
Pub.dev archives each package independently. Ensure each published package has its own:
- LICENSE
- README.md (documenting the package's API or CLI usage)
- CHANGELOG.md (documenting versions for that package)

2. Validation & Publishing Sequence

Because cli depends on core, core must be published first:

# 1. Validate both packages with dry-run
cd packages/core && dart pub publish --dry-run
cd ../cli && dart pub publish --dry-run

# 2. Publish core
cd ../core && dart pub publish

# 3. Publish cli (after core is live on pub.dev)
cd ../cli && dart pub publish

Once published, end users can install your CLI globally:

dart pub global activate <cli_package_name>
<executable_name> --help

3. Automated Publishing via GitHub Actions (Trusted Publishing)

pub.dev supports Trusted Publishing using GitHub Actions OIDC (no stored tokens or secrets required):

In pub.dev package settings, configure GitHub Actions as the publisher (specifying repository and workflow).

Add a publishing job to .github/workflows/release.yml:

publish-pub-dev:
  name: Publish to pub.dev
  needs: [verify, test]
  runs-on: ubuntu-latest
  permissions:
    id-token: write # Required for pub.dev OIDC authentication
  steps:
    - uses: actions/checkout@v4
    - uses: dart-lang/setup-dart@v1
    - name: Publish Core
      run: dart pub publish --force
      working-directory: packages/core
    - name: Publish CLI
      run: dart pub publish --force
      working-directory: packages/cli