カスタムユーザーフィールドの作成と設定

オプションが多いDiscourseの複数選択カスタムユーザーフィールドの作成

Discourseのカスタムユーザーフィールドエディターで数十または数百の選択肢を1つずつ入力するのは面倒です。Discourse向けの汎用CLIツール dsc を開発しており、ローカルファイルを使用することで、こうした操作をより簡単かつ確実に行えるようにしています。カスタムユーザーフィールドの操作も、dsc ができることの一つにすぎません。

dsc を使えば、YAMLファイルから新しいカスタムユーザーフィールドを作成でき、並べ替え済みの全選択肢リストを1回の操作で取り込めます。ucf コマンドは user-field のエイリアスです。

まず、既存のカスタムユーザーフィールドの一覧を表示します。

dsc ucf list myforum --format yaml

これにより、フィールドのID、タイプ、オプション、設定が表示されます。

フィールドの準備

user-fields.yaml を作成し、URL、質問文、オプションを自分のものに置き換えてください。YAML構文が有効であることを必ず確認してください。ミスを起こしやすいので注意が必要です。

たとえば、25のオプションを持つ「国」の複数選択フィールドの場合は次のようになります。

version: 1
source: https://forum.example.org
user_fields:
  - name: Countries
    description: Which countries do you work in? Select all that apply.
    field_type: multiselect
    editable: true
    requirement: on_signup
    show_on_profile: false
    show_on_signup: true
    show_on_user_card: false
    searchable: false
    options:
      - Argentina
      - Australia
      - Brazil
      - Canada
      - China
      - Denmark
      - Egypt
      - France
      - Germany
      - India
      - Ireland
      - Italy
      - Japan
      - Kenya
      - Mexico
      - Netherlands
      - New Zealand
      - Nigeria
      - Norway
      - Singapore
      - South Africa
      - Spain
      - Sweden
      - United Kingdom
      - United States

これは「25の個別フィールド」ではなく、「1つのフィールドに25のオプションを持たせる」という定義です。必要に応じてリストを拡張できます。私はこのアプローチを250以上のオプションを持つフィールドで実証済です。

プレビュー、作成、検証

dsc ucf push --dry-run myforum user-fields.yaml
# 適用前に、実行計画とYAMLファイル全体の内容を確認してください。
dsc ucf push myforum user-fields.yaml
dsc ucf show myforum <field-id> --format yaml

dsc に関するご意見や、追加してほしい機能など、フィードバックを歓迎します。GitHub リポジトリで Issue を作成してください。

「いいね!」 2